Prompt file imported from djaus2/Drafts (
.windsurf/workflows/docs.md). Copyright stays with the author.
This workflow helps you rescan the project and keep the progressive documentation in /docs aligned with the codebase.
1) Quick project scan (what changed?)
-
Review core entry points and confirm they still match the docs:
Program.cs(DI registrations, auth, endpoints)Draughts.csproj(target framework, packages)Components/Routes.razor(public vs protected routes)Services/*(major behavior changes)Data/*(schema / seeding changes)
-
Identify the feature area you touched (pick one):
- Authentication / PIN management
- Groups / membership
- Lobby chat / in-game chat
- Voice / speech
- Game rules / sequencing / timeouts
- Logging / telemetry
- AI player
- Azure deployment
2) Docs folder rescan
- Open
/docs/index.mdand confirm it includes links for any new docs you added. - If you introduced a new feature or non-trivial fix, add a new markdown file under
/docs/and link it from/docs/index.md. - If you changed behavior that affects users, update the latest release notes file:
- Prefer updating the newest
docs/v*.mdrelease notes, or add a new release notes file if you’ve bumped the app version.
- Prefer updating the newest
3) Consistency checks
- Version consistency:
- Confirm the version shown in the app (Home page reads from
auth.json) matches the latest release notes headline.
- Confirm the version shown in the app (Home page reads from
- Group-aware behavior consistency (if applicable):
- If you changed game visibility rules, ensure
groups-feature-implementation.mdand related chat docs still reflect the rules.
- If you changed game visibility rules, ensure
- Azure notes consistency (if applicable):
- If you changed authentication or DB paths, update the Azure troubleshooting docs.
- Logging consistency (if applicable):
- If you added/changed log event types, update
structured-logging-system.md.
- If you added/changed log event types, update
4) Optional: add a short “what changed” entry
Add a brief section near the top of the relevant doc describing:
- What changed
- Why it changed
- How to test it
5) Final step
Ensure:
/docs/index.mdlinks to any new or renamed docs- Any new screenshots under
/docs/are referenced from at least one markdown file - Release notes (if updated) mention user-visible changes