docs: publish docs/ as a just-the-docs GitHub Pages site#31
Merged
Conversation
Scaffolds a searchable documentation site (https://microsoft.github.io/capacity-toolkit/) from the existing docs/ Markdown, mirroring the Microsoft FinOps toolkit approach: - docs/_config.yml using the just-the-docs remote theme, served from /docs on main (relative-links, seo-tag, rouge PowerShell/JSON/bicep highlighting, mermaid, callouts, logo, aux + edit-on-GitHub links). - Navigation front-matter (title + nav_order) on all eight pages; index.md is the home page. - Rewrote the five out-of-docs relative links (AGENTS/README/LICENSE/SECURITY) to absolute GitHub URLs so they resolve on the published site. - docs/Gemfile for local preview (bundle exec jekyll serve). - README docs badge + link; CHANGELOG [Unreleased] entry. No content moved; the Markdown remains the source of truth. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Scaffolds a searchable documentation site at https://microsoft.github.io/capacity-toolkit/ from the existing
docs/Markdown, mirroring the Microsoft FinOps toolkit approach (Jekyll +just-the-docsremote theme, served from/docsonmain).What's included
docs/_config.yml— just-the-docs remote theme, relative-links + seo-tag plugins, rouge PowerShell/JSON/bicep highlighting, mermaid, callouts, logo, aux + edit-on-GitHub links.title+nav_order) on all eight pages;index.mdis the home page.docs/relative links (AGENTS / README / LICENSE / SECURITY) to absolute GitHub URLs so they resolve on the published site.docs/Gemfilefor local preview (cd docs && bundle exec jekyll serve).[Unreleased]entry..gitignore: ignore local Guardian.gdn/artifacts and Jekyll build output.No content moved — the Markdown remains the source of truth.
After merge
Enable Settings → Pages → Deploy from a branch →
main//docs(I'll do this via the API once merged), then verify the Pages build succeeds.