docs: documentation overhaul - central site#16
Merged
Conversation
added 8 commits
March 7, 2026 15:38
- Fix playbook URLs (Luftfartsverket -> reqstool) - Add all missing component repos to playbook - Create landing page component (overview, getting-started, components) - Add local-antora-playbook.yml for local dev - Add package.json with build scripts - Add supplemental UI (branding, logo, .nojekyll) - Add CONTRIBUTING.md - Update README.md - Set start_page to reqstool::index.adoc - Update .gitignore for Antora build artifacts Signed-off-by: jimisola <jimisola@jimisola.com>
Paths need ../../ prefix since playbook is inside docs/ and sibling repos are one level above the repo root. Signed-off-by: jimisola <jimisola@jimisola.com>
Use ../supplemental-ui instead of supplemental-ui to be explicit relative to the docs/ directory where playbooks live. Signed-off-by: jimisola <jimisola@jimisola.com>
Change relative paths from ../../ to ../ to correctly resolve sibling repos from the playbook file location. Signed-off-by: jimisola <jimisola@jimisola.com>
Signed-off-by: jimisola <jimisola@jimisola.com>
Signed-off-by: jimisola <jimisola@jimisola.com>
Move data.adoc, file_and_directory_set.adoc (as files-and-directories.adoc), and general concepts from how_it_works.adoc into the central reqstool component. Add concepts.adoc with annotations, parsing, custom paths, and validation. Update nav with new pages. Fix local playbook UI bundle path. Signed-off-by: jimisola <jimisola@jimisola.com>
Antora resolves paths starting with '..' relative to CWD, not the playbook directory. Use './../supplemental-ui' (dot-prefixed) so the path resolves via the playbook dir instead. Use cached UI bundle for local playbook to avoid network dependency. Signed-off-by: jimisola <jimisola@jimisola.com>
Signed-off-by: jimisola <jimisola@jimisola.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.
Summary
reqstool) with overview, ecosystem diagram, getting started, components, background, terminology, and concepts pages..paths from CWD, not playbook dir).nojekyllvia supplemental UI for GitHub Pagespackage.jsonwith build scriptsstart_page: reqstool::index.adocTest plan
npm run build:local(71 HTML pages, 0 warnings)