Skip to content

💎 Showcase: [Refinement] Organize Documentation Map #395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
google-labs-jules wants to merge 1 commit into
base: main
Choose a base branch
from
Open

💎 Showcase: [Refinement] Organize Documentation Map #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .jules/showcase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
* **Missing Contributing Guide:** [RESOLVED] Users looking to contribute have no clear entry point. `CONTRIBUTING.md` has been enhanced with project structure and testing details.
* **Deployment Info Clutter:** Deployment instructions were mixed with local run instructions, making the "Quick Start" hard to find. These have been moved to `docs/DEPLOYMENT.md`.
* **Misleading Quick Start:** The `npm run dev` command implied it started the full stack, but the worker required a separate process. This led to "PENDING" simulation states for new users.
* **Unorganized Documentation Map:** [RESOLVED] The README's documentation map was a flat list of 12 unorganized links, causing navigation friction. Categorized into Core, Operations, and Worker setup to improve discovery.

16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,29 @@ cd worker_flutter && flutter run -d macos # or: -d windows

## Documentation Map

**Core Architecture & API**
* [Architecture Overview](docs/ARCHITECTURE.md)
* [Architecture Issues](docs/ARCHITECTURE_ISSUES.md)
* [API Reference](API.md)
* [Data Flow](DATA_FLOW.md)

**Deployment & Operations**
* [Deployment Guide](docs/DEPLOYMENT.md)
* [Implementation Plan](docs/IMPLEMENTATION_PLAN_WORKER_SPLIT.md)
* [Mode Setup](docs/MODE_SETUP.md)
* [Precon Sync](docs/PRECON_SYNC.md)
* [Secrets Setup](docs/SECRETS_SETUP.md)
* [Precon Sync](docs/PRECON_SYNC.md)
* [Stale Sweeper](docs/STALE_SWEEPER.md)
* [Sweeper Alerting](docs/SWEEPER_ALERTING.md)
* [Sweeper Alert Policy](docs/sweeper-alert-policy.yaml)

**Desktop Worker (Flutter)**
* [Auth Setup](worker_flutter/docs/AUTH_SETUP.md)
* [App Check Setup](worker_flutter/docs/APP_CHECK_SETUP.md)
* [Sentry Setup](worker_flutter/docs/sentry-setup.md)

**Legacy / Planning**
* [Architecture Issues](docs/ARCHITECTURE_ISSUES.md)
* [Implementation Plan](docs/IMPLEMENTATION_PLAN_WORKER_SPLIT.md)

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) to get started.
Loading