Ninosaurier/LUNA-Charts
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Set up documentation infrastructure ("Docs-as-Code") #6

New Issue
Closed
opened 2026-07-22 16:20:46 +00:00 by Ninosaurier · 0 comments
Ninosaurier commented 2026-07-22 16:20:46 +00:00
Owner
Copy Link
Copy Source

Context

Architecture documentation only stays useful if it's easy to write, review, and keep in sync with the code — which requires treating docs as a first-class, versioned part of the repository rather than an external wiki or slide deck.

What was done

  • Set up a Starlight-based (Astro) documentation site inside the monorepo (docs/)
  • Structured content under docs/src/content/docs/, with dedicated sections for architecture (ADR/ADM) and getting-started guides
  • Ensured documentation changes go through the same PR review process as code changes, per the governance model

Outcome

  • Documentation site scaffolded and building successfully under docs/
  • Architecture documentation (ADRs, ADM) and getting-started guides (installation, project structure, roadmap) live in this system

Related

  • docs/astro.config.mjs
  • docs/src/content/docs/
## Context Architecture documentation only stays useful if it's easy to write, review, and keep in sync with the code — which requires treating docs as a first-class, versioned part of the repository rather than an external wiki or slide deck. ## What was done - Set up a Starlight-based (Astro) documentation site inside the monorepo (`docs/`) - Structured content under `docs/src/content/docs/`, with dedicated sections for architecture (ADR/ADM) and getting-started guides - Ensured documentation changes go through the same PR review process as code changes, per the governance model ## Outcome - Documentation site scaffolded and building successfully under `docs/` - Architecture documentation (ADRs, ADM) and getting-started guides (installation, project structure, roadmap) live in this system ## Related - `docs/astro.config.mjs` - `docs/src/content/docs/`
Ninosaurier added this to the v0.1.0 - Phase 1: Groundwork milestone 2026-07-22 16:20:46 +00:00
Ninosaurier self-assigned this 2026-07-22 16:20:46 +00:00
Ninosaurier added the Priority/HighKind/Documentation labels 2026-07-22 19:11:10 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Community/Good First Issue
Suitable for newcomers making their first contribution.
 Community/Question
General questions or discussions without implementation work.
 Kind/Bug
Something is not working correctly.
 Kind/Documentation
Documentation changes or improvements.
 Kind/Enhancement
Improves existing functionality.
 Kind/Feature
Introduces new functionality.
 Kind/Refactoring
Improves internal implementation without changing external behavior.
 Kind/Testing
Related to tests or testing infrastructure.
 Priority/High
High priority.
 Priority/Low
Low priority.
 Priority/Medium
Normal priority.
 Status/Blocked
Progress is blocked by another dependency or issue.
 Status/Needs Information
More details or steps to reproduce are required from the author before proceeding.
 Status/Needs Review
Waiting for maintainer or reviewer feedback.
 Status/Verified
The issue has been verified and confirmed.
No labels Kind/Documentation Priority/High
Milestone
No items
No Milestone v0.1.0 - Phase 1: Groundwork
Projects
Clear projects
No projects
Assignees
Clear assignees
Ninosaurier (Antonino Provenzano)
No Assignees Ninosaurier
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Ninosaurier/LUNA-Charts#6