Skip to content

docs: documentation overhaul#104

Merged
jimisola merged 8 commits intomainfrom
docs/documentation-overhaul
Mar 7, 2026
Merged

docs: documentation overhaul#104
jimisola merged 8 commits intomainfrom
docs/documentation-overhaul

Conversation

@jimisola
Copy link
Member

@jimisola jimisola commented Mar 7, 2026

Summary

  • Standardize README.md with consistent badge set and structure
  • Add CONTRIBUTING.md with repo-specific dev setup
  • Update/add Antora docs: streamline nav, add content pages
  • Remove per-repo GitHub Pages deployment (consolidated to reqstool.github.io)
  • Update antora-playbook.yml URLs from Luftfartsverket to reqstool

Test plan

  • Antora docs build without warnings in central site
  • Verify docs render correctly on central site

Jimisola Laursen added 6 commits March 7, 2026 15:25
- Standardize README.md with consistent badges and structure
- Add CONTRIBUTING.md with repo-specific dev setup
- Add/update Antora docs structure
- Remove per-repo GitHub Pages workflow
- Point documentation badge to central site

Signed-off-by: jimisola <jimisola@jimisola.com>
Signed-off-by: jimisola <jimisola@jimisola.com>
- Add description with features, quick start, minimal setup, prerequisites
- Rewrite installation.adoc as configuration reference
- Rewrite usage with basic usage, decorator dependency, lifecycle
- Simplify license to uniform format
- Simplify nav to single Start entry

Signed-off-by: jimisola <jimisola@jimisola.com>
- Separate nav items instead of single include-based page
- Merge description.adoc content into index.adoc
- Rename installation.adoc to configuration.adoc (matches actual content)
- Add inline license to index.adoc
- Change nav label from Start to Overview

Signed-off-by: jimisola <jimisola@jimisola.com>
Signed-off-by: jimisola <jimisola@jimisola.com>
Signed-off-by: jimisola <jimisola@jimisola.com>
@jimisola jimisola self-assigned this Mar 7, 2026
@jimisola jimisola merged commit 4acc90d into main Mar 7, 2026
6 checks passed
@jimisola jimisola deleted the docs/documentation-overhaul branch March 7, 2026 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant