Skip to content

Commit 8b5ee64

Browse files
authored
feat: migrate to custom domain docs.specfact.io (#87)
* 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 * fix: resolve Jekyll build errors for GitHub Pages - Quote title in speckit-journey.md frontmatter to fix YAML parsing error - Wrap Jinja2 template code in {% raw %} tags in agile-scrum-workflows.md to prevent Jekyll from parsing it as Liquid syntax Fixes GitHub Pages build errors: - YAML Exception in speckit-journey.md (line 3) - Liquid syntax error in agile-scrum-workflows.md (line 708) * docs: add new pages to GitHub Pages navigation menu - Add Command Chains to Guides section - Add Agile/Scrum Workflows to Guides section - Add Reference Documentation index to Reference section These pages were missing from the navigation menu after fixing permalinks. * docs: add new pages to GitHub Pages sidebar navigation menu - Add Command Chains to Guides section (top of list) - Add Agile/Scrum Workflows to Guides section - Add Reference Documentation index to Reference section - Fix reference links to use correct permalinks (/reference/architecture/, etc.) The sidebar navigation menu is hardcoded in the layout file, so these pages need to be manually added to appear in the left sidebar. * feat: add Mermaid.js support for diagram rendering on GitHub Pages - Add Mermaid.js CDN script to layout - Add JavaScript to convert mermaid code blocks to renderable divs - Handle kramdown output format (pre > code.language-mermaid) - Initialize Mermaid with proper configuration Fixes Mermaid diagram rendering on GitHub Pages documentation. All mermaid code blocks will now render as interactive diagrams. * feat: align GitHub Pages styling with specfact.io design - Update color scheme to match specfact.io (dark theme with cyan accent) - Change primary colors: #64ffda (cyan), #0a192f (dark blue), #112240 (light dark) - Update Mermaid theme to dark with custom colors matching specfact.io - Add Inter and JetBrains Mono fonts to match specfact.io typography - Add Mermaid-specific CSS styling for better diagram appearance - Remove light mode support, use dark theme consistently Colors now match specfact.io: - Primary/Highlight: #64ffda (cyan) - Background: #0a192f (dark blue) - Text: #ccd6f6 (light blue-gray) - Code background: #1d2d50 (darker blue) Mermaid diagrams now use dark theme with cyan accents for better readability and visual consistency with specfact.io documentation site. * fix: improve YAML and code syntax highlighting for dark theme - Update Rouge syntax highlighting colors for dark theme readability - Use cyan (#64ffda) for literals, numbers, and constants - Use light green (#a8e6cf) for strings (better contrast on dark) - Use pink (#ff6b9d) for keywords and operators - Use purple (#c792ea) for functions and classes - Use yellow (#ffd93d) for variables - Use muted gray-blue (#8892b0) for comments - YAML keys now use cyan color for better visibility Fixes readability issues with YAML and other code blocks on dark background. * feat: update to custom domain docs.specfact.io - Update _config.yml: set baseurl to empty string for custom domain - Update _config.yml: set url to https://docs.specfact.io - Exclude assets/ from default permalink pattern to fix CSS path - Update README.md to use new docs.specfact.io domain - Fixes CSS 404 errors on custom domain --------- Co-authored-by: Dominikus Nold <[email protected]>
1 parent 86bee62 commit 8b5ee64

File tree

4 files changed

+199
-93
lines changed

4 files changed

+199
-93
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<div align="center">
1414

15-
**[🌐 specfact.com](https://specfact.com)****[📚 specfact.io](https://specfact.io)****[👨‍💻 specfact.dev](https://specfact.dev)****[📖 GitHub Pages Docs](https://nold-ai.github.io/specfact-cli/)****[💬 Support](mailto:[email protected])**
15+
**[🌐 specfact.com](https://specfact.com)****[📚 specfact.io](https://specfact.io)****[👨‍💻 specfact.dev](https://specfact.dev)****[📖 Documentation](https://docs.specfact.io/)****[💬 Support](mailto:[email protected])**
1616

1717
</div>
1818

@@ -21,7 +21,7 @@
2121
- **[specfact.com](https://specfact.com)** - Commercial landing page (marketing, pricing, enterprise)
2222
- **[specfact.io](https://specfact.io)** - Product ecosystem hub (CLI reference, integrations, changelog, product docs)
2323
- **[specfact.dev](https://specfact.dev)** - Developer community (tutorials, guides, blog, community content) ⭐ **For developers**
24-
- **[GitHub Pages Docs](https://nold-ai.github.io/specfact-cli/)** - Complete online documentation
24+
- **[docs.specfact.io](https://docs.specfact.io/)** - Complete online documentation
2525

2626
---
2727

@@ -233,7 +233,7 @@ specfact import from-code my-project --repo .
233233
- **[DevOps Adapter Integration](docs/guides/devops-adapter-integration.md)** - GitHub Issues, Linear, Jira
234234

235235
👉 **[Full Documentation Index](docs/README.md)** - Browse all documentation
236-
👉 **[GitHub Pages Documentation](https://nold-ai.github.io/specfact-cli/)** - Online documentation site
236+
👉 **[Online Documentation](https://docs.specfact.io/)** - Complete documentation site
237237

238238
---
239239

docs/_config.yml

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
title: SpecFact CLI Documentation
55
description: >-
66
Complete documentation for SpecFact CLI - Brownfield-first CLI: Reverse engineer legacy Python → specs → enforced contracts.
7-
baseurl: "/specfact-cli" # Project pages require baseurl
8-
url: "https://nold-ai.github.io" # GitHub Pages domain
7+
baseurl: "" # Custom domain at root, no baseurl needed
8+
url: "https://docs.specfact.io" # Custom domain
99

1010
# Build settings
1111
markdown: kramdown
@@ -36,7 +36,6 @@ exclude:
3636
- scripts
3737
- specs
3838
- resources
39-
- "*.css.map" # Exclude source map files
4039

4140
# Source and destination (Jekyll will look for files in docs/)
4241
# Note: For GitHub Pages, Jekyll typically expects source in root or docs/
@@ -46,13 +45,21 @@ destination: _site
4645

4746
# Defaults
4847
defaults:
49-
# Apply permalink pattern only to markdown pages
50-
# Note: Assets (SCSS files) are not pages, so they won't be affected by this
48+
# Default layout for all pages
5149
- scope:
5250
path: ""
5351
type: pages
5452
values:
5553
layout: default
54+
# Apply permalink pattern only to markdown files (exclude assets)
55+
# Note: SCSS files with front matter are treated as pages and inherit this pattern
56+
# We exclude assets/ directory to prevent CSS from being output at main/index.css
57+
- scope:
58+
path: ""
59+
type: pages
60+
exclude:
61+
- "assets/**"
62+
values:
5663
permalink: /:basename/
5764
- scope:
5865
path: "getting-started"
@@ -89,7 +96,7 @@ minima:
8996
# sass_dir is only needed for custom SASS partials directory
9097
sass:
9198
style: compressed
92-
sourcemap: never # Disable source maps to avoid conflicts
99+
sourcemap: never # Disable source maps to prevent JSON output
93100

94101
# Footer
95102
footer:

docs/_layouts/default.html

Lines changed: 56 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
{% seo %}
8+
<!-- Fonts -->
9+
<link rel="preconnect" href="https://fonts.googleapis.com" />
10+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
11+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet" />
812
<link rel="stylesheet" href="{{ '/assets/main.css' | relative_url }}">
913
<link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ '/feed.xml' | relative_url }}">
1014
{% if jekyll.environment == 'production' and site.google_analytics %}
@@ -34,12 +38,61 @@
3438
}
3539
});
3640

37-
// Initialize Mermaid after converting all blocks
41+
// Initialize Mermaid with dark theme matching specfact.io colors
3842
mermaid.initialize({
3943
startOnLoad: true,
40-
theme: 'default',
44+
theme: 'dark',
4145
securityLevel: 'loose',
42-
flowchart: { useMaxWidth: true }
46+
flowchart: {
47+
useMaxWidth: true,
48+
htmlLabels: true,
49+
curve: 'basis'
50+
},
51+
themeVariables: {
52+
darkMode: true,
53+
primaryColor: '#64ffda',
54+
primaryTextColor: '#ccd6f6',
55+
primaryBorderColor: '#64ffda',
56+
lineColor: '#64ffda',
57+
secondaryColor: '#112240',
58+
tertiaryColor: '#1d2d50',
59+
background: '#0a192f',
60+
mainBkgColor: '#112240',
61+
secondBkgColor: '#1d2d50',
62+
textColor: '#ccd6f6',
63+
border1: '#64ffda',
64+
border2: '#8892b0',
65+
noteBkgColor: '#1d2d50',
66+
noteTextColor: '#ccd6f6',
67+
noteBorderColor: '#64ffda',
68+
actorBorder: '#64ffda',
69+
actorBkg: '#112240',
70+
actorTextColor: '#ccd6f6',
71+
actorLineColor: '#64ffda',
72+
labelBoxBkgColor: '#112240',
73+
labelBoxBorderColor: '#64ffda',
74+
labelTextColor: '#ccd6f6',
75+
loopTextColor: '#ccd6f6',
76+
activationBorderColor: '#64ffda',
77+
activationBkgColor: '#1d2d50',
78+
sequenceNumberColor: '#0a192f',
79+
sectionBkgColor: '#1d2d50',
80+
altBkgColor: '#112240',
81+
critBkgColor: '#1d2d50',
82+
doneBkgColor: '#64ffda',
83+
doneBorderColor: '#64ffda',
84+
taskBorderColor: '#64ffda',
85+
taskBkgColor: '#112240',
86+
taskTextLightColor: '#ccd6f6',
87+
taskTextColor: '#ccd6f6',
88+
taskTextDarkColor: '#0a192f',
89+
taskTextOutsideColor: '#ccd6f6',
90+
taskTextClickableColor: '#64ffda',
91+
activeTaskBorderColor: '#64ffda',
92+
activeTaskBkgColor: '#1d2d50',
93+
gridColor: '#8892b0',
94+
critBorderColor: '#64ffda'
95+
}
4396
});
4497
});
4598
</script>

0 commit comments

Comments
 (0)