From 32aacfa910f020a4d84eb7eda2b010fc2555b6ae Mon Sep 17 00:00:00 2001 From: JohnDoe6345789 Date: Thu, 25 Dec 2025 22:33:00 +0000 Subject: [PATCH] docs: start,here (1 files) --- docs/START_HERE.md | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/START_HERE.md b/docs/START_HERE.md index 3521f3e9c..e38833374 100644 --- a/docs/START_HERE.md +++ b/docs/START_HERE.md @@ -2,8 +2,6 @@ Welcome to MetaBuilder! This file helps you navigate to where you need to go. -TODO: This file is in docs/ so ./docs/ links are broken; the root-level file list below is outdated (README/CONTRIBUTING live elsewhere or do not exist). - --- ## Current Workflow (0-kickstart) @@ -24,28 +22,28 @@ If you're unsure which workflow to follow, start with `../.github/prompts/0-kick **All MetaBuilder documentation is in the `/docs` folder.** ### πŸ‘€ For New Team Members -**[β†’ Read: docs/getting-started/NEW_CONTRIBUTOR_PATH.md](./docs/getting-started/NEW_CONTRIBUTOR_PATH.md)** +**[β†’ Read: getting-started/NEW_CONTRIBUTOR_PATH.md](./getting-started/NEW_CONTRIBUTOR_PATH.md)** - Structured 2-3 hour learning path - Learn architecture, testing, development workflow - Get familiar with codebase patterns - βœ… **START HERE** if you're new ### πŸ—ΊοΈ For Finding Specific Topics -**[β†’ Use: docs/NAVIGATION.md](./docs/NAVIGATION.md)** +**[β†’ Use: NAVIGATION.md](./NAVIGATION.md)** - Complete guide to all documentation - Organized by category - Quick links to common tasks - 144+ documentation files indexed ### πŸ“– For General Navigation -**[β†’ Go to: docs/INDEX.md](./docs/INDEX.md)** +**[β†’ Go to: INDEX.md](./INDEX.md)** - Quick navigation hub - Category overview - Fast access to key documents ### πŸ“‹ For Full Organization Guide **[β†’ See: DOCS_ORGANIZATION_GUIDE.md](./DOCS_ORGANIZATION_GUIDE.md)** ← You are here! -**[β†’ See: docs/ORGANIZATION.md](./docs/ORGANIZATION.md)** +**[β†’ See: ORGANIZATION.md](./ORGANIZATION.md)** - How documentation is structured - Directory breakdown - Contributing guidelines @@ -56,14 +54,14 @@ If you're unsure which workflow to follow, start with `../.github/prompts/0-kick | Goal | Link | Time | |------|------|------| -| **I'm new to MetaBuilder** | [NEW_CONTRIBUTOR_PATH](./docs/getting-started/NEW_CONTRIBUTOR_PATH.md) | 2-3 hrs | -| **I want to set up dev environment** | [getting-started/README](./docs/getting-started/README.md) | 30 min | -| **I need to understand the architecture** | [architecture/5-level-system](./docs/architecture/5-level-system.md) | 15 min | -| **I need to write tests** | [testing/TESTING_GUIDELINES](./docs/testing/TESTING_GUIDELINES.md) | 10 min | -| **I need to create a component** | [guides/getting-started](./docs/guides/getting-started.md) | 20 min | -| **I need to work with the database** | [DBAL_INTEGRATION](./docs/implementation/DBAL_INTEGRATION.md) | 30 min | -| **I need to deploy** | [deployments/README](./docs/deployments/README.md) | 15 min | -| **I'm stuck - troubleshooting** | [troubleshooting/README](./docs/troubleshooting/README.md) | varies | +| **I'm new to MetaBuilder** | [NEW_CONTRIBUTOR_PATH](./getting-started/NEW_CONTRIBUTOR_PATH.md) | 2-3 hrs | +| **I want to set up dev environment** | [getting-started/README](./getting-started/README.md) | 30 min | +| **I need to understand the architecture** | [architecture/5-level-system](./architecture/5-level-system.md) | 15 min | +| **I need to write tests** | [testing/TESTING_GUIDELINES](./testing/TESTING_GUIDELINES.md) | 10 min | +| **I need to create a component** | [guides/getting-started](./guides/getting-started.md) | 20 min | +| **I need to work with the database** | [DBAL_INTEGRATION](./implementation/DBAL_INTEGRATION.md) | 30 min | +| **I need to deploy** | [deployments/README](./deployments/README.md) | 15 min | +| **I'm stuck - troubleshooting** | [troubleshooting/README](./troubleshooting/README.md) | varies | | **I need project overview** | [README](./README.md) | 10 min | --- @@ -71,28 +69,30 @@ If you're unsure which workflow to follow, start with `../.github/prompts/0-kick ## πŸš€ Next Steps ### Step 1: Choose Your Path -- **New to MetaBuilder?** β†’ [NEW_CONTRIBUTOR_PATH](./docs/getting-started/NEW_CONTRIBUTOR_PATH.md) -- **Need a specific topic?** β†’ [NAVIGATION.md](./docs/NAVIGATION.md) +- **New to MetaBuilder?** β†’ [NEW_CONTRIBUTOR_PATH](./getting-started/NEW_CONTRIBUTOR_PATH.md) +- **Need a specific topic?** β†’ [NAVIGATION.md](./NAVIGATION.md) ### Step 2: Jump In Follow the guides for your role and tasks. ### Step 3: Keep These Handy -- [Copilot Instructions](./docs/../../.github/copilot-instructions.md) - Development standards -- [NAVIGATION.md](./docs/NAVIGATION.md) - Find anything -- [troubleshooting/README](./docs/troubleshooting/README.md) - Solve problems +- [Copilot Instructions](../.github/copilot-instructions.md) - Development standards +- [NAVIGATION.md](./NAVIGATION.md) - Find anything +- [troubleshooting/README](./troubleshooting/README.md) - Solve problems --- ## πŸ“‚ Quick File Locations -**At root level** (kept minimal): -- `README.md` - Project overview +**At docs root** (kept minimal): +- `README.md` - Documentation overview - `CONTRIBUTING.md` - How to contribute - `START_HERE.md` - This file +- `INDEX.md` - Quick navigation hub +- `NAVIGATION.md` - Full navigation guide - `DOCS_ORGANIZATION_GUIDE.md` - Docs navigation guide -**Everything else** is in `/docs/` folder: +**Documentation folders**: ``` docs/ β”œβ”€β”€ getting-started/ ← Start here! @@ -108,7 +108,7 @@ docs/ --- **πŸ‘‰ Ready to start?** -β†’ **[Go to docs/getting-started/NEW_CONTRIBUTOR_PATH.md](./docs/getting-started/NEW_CONTRIBUTOR_PATH.md)** +β†’ **[Go to getting-started/NEW_CONTRIBUTOR_PATH.md](./getting-started/NEW_CONTRIBUTOR_PATH.md)** └─ Testing approach ```