Restructure README project listing by stage; scaffold docs for three upcoming games#11
Conversation
… Not Shoot Aliens, Space Sim Co-authored-by: iaretechnician <2749183+iaretechnician@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Restructures the project listings to reflect project stage (current/completed/upcoming) and scaffolds application-specific documentation for three upcoming games under docs/applications/, with corresponding MkDocs navigation entries.
Changes:
- Restructured project tables in
README.mdanddocs/INDEX.mdinto stage-based sections and clarified that docs remain indocs/applications/when a project changes stage. - Added full documentation scaffolds (README/Overview/Getting Started/Gameplay/Implementation Notes) for Castle Walls, Do Not Shoot Aliens, and Space Sim.
- Updated
mkdocs.ymlto include the three new applications in the documentation site nav.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds MkDocs nav entries for the three new upcoming game doc sets. |
| README.md | Splits the projects list into stage-based sections and points to docs/applications/ as the documentation root. |
| docs/INDEX.md | Splits the docs index into stage-based sections and updates “Adding a New Application” guidance for staged workflow. |
| docs/applications/castle-walls/README.md | Adds application landing page with doc links and public links. |
| docs/applications/castle-walls/Overview.md | Adds overview scaffold describing concept, features, architecture, and status. |
| docs/applications/castle-walls/Getting-Started.md | Adds “in development” getting-started stub with roadmap pointers. |
| docs/applications/castle-walls/Gameplay.md | Adds “in development” gameplay stub with roadmap pointers. |
| docs/applications/castle-walls/Implementation-Notes.md | Adds implementation-notes scaffold with components and platform targets. |
| docs/applications/do-not-shoot-aliens/README.md | Adds application landing page with doc links and public links. |
| docs/applications/do-not-shoot-aliens/Overview.md | Adds overview scaffold describing concept, features, architecture, and status. |
| docs/applications/do-not-shoot-aliens/Getting-Started.md | Adds “in development” getting-started stub with roadmap pointers. |
| docs/applications/do-not-shoot-aliens/Gameplay.md | Adds “in development” gameplay stub with roadmap pointers. |
| docs/applications/do-not-shoot-aliens/Implementation-Notes.md | Adds implementation-notes scaffold with components and platform targets. |
| docs/applications/space-sim/README.md | Adds application landing page with doc links and public links. |
| docs/applications/space-sim/Overview.md | Adds overview scaffold describing concept, features, architecture, and status. |
| docs/applications/space-sim/Getting-Started.md | Adds “in development” getting-started stub with roadmap pointers. |
| docs/applications/space-sim/Gameplay.md | Adds “in development” gameplay stub with roadmap pointers. |
| docs/applications/space-sim/Implementation-Notes.md | Adds implementation-notes scaffold with components and platform targets. |
| | **Resource management** | Gather and allocate resources between offense, defense, and repairs. | | ||
| | **Multiple maps** | Different terrain layouts with unique strategic challenges. | | ||
| | **Progression** | Unlock new structures and upgrades as you advance. | | ||
| | **Platform support** | PC (Windows and Linux). | |
There was a problem hiding this comment.
In the Features table, "Platform support" is written as if PC support exists already, but the Development Status section below marks PC (Windows/Linux) support as "Planned". Please make these consistent (e.g., change the Features row to "Target platforms" / "Planned" wording).
| | **Platform support** | PC (Windows and Linux). | | |
| | **Target platforms** | PC (Windows/Linux) (planned). | |
| | **Escalating wave design** | Encounters grow faster and more visually complex as the game progresses. | | ||
| | **Score system** | Points awarded for correct holds and correct shots; deducted for friendly fire. | | ||
| | **Multiple environments** | Different backdrops and alien designs challenge visual recognition. | | ||
| | **Platform support** | PC (Windows and Linux). | |
There was a problem hiding this comment.
In the Features table, "Platform support" is written as if PC support exists already, but the Development Status section below marks PC (Windows/Linux) support as "Planned". Please make these consistent (e.g., change the Features row to "Target platforms" / "Planned" wording).
| | **Platform support** | PC (Windows and Linux). | | |
| | **Target platforms** | PC (Windows/Linux) – planned. | |
| | **Resource gathering** | Mine asteroids and harvest planetary resources to fuel and upgrade your ship. | | ||
| | **Ship management** | Maintain, repair, and customize your vessel to survive deep space. | | ||
| | **Survival mechanics** | Manage fuel, hull integrity, crew, and life support across long voyages. | | ||
| | **Platform support** | PC (Windows and Linux). | |
There was a problem hiding this comment.
In the Features table, "Platform support" is written as if PC support exists already, but the Development Status section below marks PC (Windows/Linux) support as "Planned". Please make these consistent (e.g., change the Features row to "Target platforms" / "Planned" wording).
| | **Platform support** | PC (Windows and Linux). | | |
| | **Target platforms** | PC (Windows and Linux) (planned). | |
| - Space Sim: | ||
| - README: applications/space-sim/README.md | ||
| - Overview: applications/space-sim/Overview.md | ||
| - Getting Started: applications/space-sim/Getting-Started.md | ||
| - Gameplay: applications/space-sim/Gameplay.md | ||
| - Implementation Notes: applications/space-sim/Implementation-Notes.md |
There was a problem hiding this comment.
The PR description says the MkDocs applications nav is alphabetically sorted, but the current ordering isn’t (e.g., "Space Sim" appears after "Roadkill" while "Van Inventory" is earlier, even though S should come before V). Either adjust the ordering to be alphabetical or update the PR description to match the intended ordering.
README had a single flat projects table with no indication of project status, no explicit pointer to
docs/applications/as the documentation root, and was missing three planned titles entirely.Changes
README.md/docs/INDEX.mddocs/applications/and that advancing a project between stages is a one-row move — no docs relocateNew upcoming project docs (
docs/applications/<app>/)README.md,Overview.md,Getting-Started.md,Gameplay.md,Implementation-Notes.mdmkdocs.yml💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.