Skip to content

Commit 16e4aed

Browse files
authored
docs: fix GitHub Pages permalinks for all documentation pages (#82)
* docs: improve documentation structure with unified command chains and cross-linking (#79) Co-authored-by: Dominikus Nold <[email protected]> * docs: add integrations overview guide (optional task 6.4) - Create integrations-overview.md with comprehensive overview of all integrations - Add links from integration guides to integrations-overview.md - Add link to integrations-overview.md in docs/README.md - Complete optional task 6.4 from improve-documentation-structure change * docs: fix linting errors in integrations-overview.md - Fix MD036 warnings by converting emphasis to proper headings - Fix MD040 warning by adding language specifier to code block * docs: simplify README and add links to new documentation - Update website links to specfact.com / .io / .dev - Add GitHub Pages docs link: https://nold-ai.github.io/specfact-cli/ - Remove version info section (avoids outdated info) - Simplify content - remove verbose sections, add links to docs instead - Add links to new documentation: - Command Chains Reference - Common Tasks Quick Reference - AI IDE Workflow Guide - Integrations Overview - Improve onboarding with clear path for new users * docs: add prominent SpecFact domain links with context - Add specfact.com, specfact.io, specfact.dev links prominently at top - Add domain purpose context (commercial, ecosystem, developer community) - Highlight specfact.dev for developers - Add GitHub Pages docs link - Improve user navigation to appropriate resources * docs: update Quick Start with correct IDE setup workflow - Add Step 2: Initialize IDE integration (specfact init --ide) - Update Step 3: Use slash commands in IDE or CLI - Add realistic timing expectations (10-15 min for typical repos) - Explain what init does (copies prompts, makes slash commands available) - Add link to AI IDE Workflow Guide - Remove unrealistic '60 seconds' claim * fix: correct heading level for SpecFact Domains section * docs: fix GitHub Pages permalinks for all documentation pages - Update permalinks to include full directory path (e.g., /reference/commands/ instead of /commands/) - Add frontmatter with permalinks to agile-scrum-workflows.md and reference/README.md - Add frontmatter with permalink to speckit-journey.md for consistency - All permalinks now match the Jekyll configuration pattern - Enables proper GitHub Pages URLs for platform-frontend sites --------- Co-authored-by: Dominikus Nold <[email protected]>
1 parent d56148f commit 16e4aed

File tree

6 files changed

+21
-3
lines changed

6 files changed

+21
-3
lines changed

docs/guides/agile-scrum-workflows.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Agile/Scrum Workflows with SpecFact CLI
4+
permalink: /guides/agile-scrum-workflows/
5+
---
6+
17
# Agile/Scrum Workflows with SpecFact CLI
28

39
This guide explains how to use SpecFact CLI for agile/scrum workflows, including backlog management, sprint planning, dependency tracking, and Definition of Ready (DoR) validation.

docs/guides/command-chains.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Command Chains Reference
4-
permalink: /command-chains/
4+
permalink: /guides/command-chains/
55
---
66

77
# Command Chains Reference

docs/guides/ide-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: IDE Integration with SpecFact CLI
4-
permalink: /ide-integration/
4+
permalink: /guides/ide-integration/
55
---
66

77
# IDE Integration with SpecFact CLI

docs/guides/speckit-journey.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: The Journey: From Spec-Kit to SpecFact
4+
permalink: /guides/speckit-journey/
5+
---
6+
17
# The Journey: From Spec-Kit to SpecFact
28

39
> **Spec-Kit and SpecFact are complementary, not competitive.**

docs/reference/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Reference Documentation
4+
permalink: /reference/
5+
---
6+
17
# Reference Documentation
28

39
Complete technical reference for SpecFact CLI.

docs/reference/commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Command Reference
4-
permalink: /commands/
4+
permalink: /reference/commands/
55
---
66

77
# Command Reference

0 commit comments

Comments
 (0)