diff --git a/contributor navigation.md b/contributor navigation.md new file mode 100644 index 00000000..c3fe5784 --- /dev/null +++ b/contributor navigation.md @@ -0,0 +1,134 @@ +# Base Documentation (Navigation Guide) + +Welcome to the **Base Docs** repository β€” the source for the official Base developer documentation. This README helps you **navigate the repo structure**, understand the **purpose of key folders/files**, and quickly find what you need to contribute or explore content. + +The documentation is published at https://docs.base.org/docs. :contentReference[oaicite:1]{index=1} + +--- + +## πŸ“¦ Repo Overview + +This repository contains: + +/ +β”œβ”€β”€ .github/ # GitHub configuration (issues templates, workflows) +β”œβ”€β”€ docs/ # All public documentation content +β”œβ”€β”€ storybook/ # UI component docs & previews +β”œβ”€β”€ README.md # This file +β”œβ”€β”€ content-instructions.md # Writing & contribution guidelines +β”œβ”€β”€ global-tone-voice.mdx # Writing style guidance +β”œβ”€β”€ mintlify-reference.md # Mintlify MDX reference +└── package-lock.json # Package lock for local development + + +--- + +## πŸ“Œ Top-Level Files + +### πŸ“ `README.md` + +This file β€” *navigation guide* β€” for visitors and contributors. + +### πŸ“š `content-instructions.md` + +Guidelines to help you write and structure docs content consistently. + +### πŸ—£οΈ `global-tone-voice.mdx` + +Defines the Base docs writing style (tone, voice, terminology). + +### πŸ“˜ `mintlify-reference.md` + +Reference for the Markdown components and formatting supported in the docs. + +--- + +## πŸ“ `docs/` β€” The Heart of the Docs + +All public documentation is inside the `docs/` folder. This content powers the Base docs site. :contentReference[oaicite:2]{index=2} + +Typical organization inside this folder mirrors the doc site navigation: + + + +docs/ +β”œβ”€β”€ get-started/ # Quickstarts for new builders +β”œβ”€β”€ learn/ # Concepts and foundational topics +β”œβ”€β”€ base-account/ # Smart accounts & wallet flows +β”œβ”€β”€ base-app/ # App building guides +β”œβ”€β”€ base-chain/ # Chain details and network info +β”œβ”€β”€ cookbook/ # Recipes & patterns +β”œβ”€β”€ mini-apps/ # Mini app platform docs +β”œβ”€β”€ onchainkit/ # SDK & integration guides +└── …other sections… + + +πŸ“Œ **Don’t add new top-level folders** β€” place new content in the most relevant existing section. :contentReference[oaicite:3]{index=3} + +--- + +## πŸš€ Getting Started Locally + +You can preview changes locally: + +1. **Install Node.js** (v19+). +2. **Install the Mint CLI**: + ```bash + npm i -g mint + + +Run the docs locally: + +cd docs +mint dev + + +Alternatively, run with: + +npx mint dev + +🀝 How to Contribute + +We welcome contributions! Here’s a quick flow: + +Fork the repo and create a descriptive branch. + +Edit or add files in the appropriate docs/... folder. + +Preview locally using the steps above. + +Open a Pull Request with a clear summary of your change. + +Tips + +Keep PRs focused and small. + +Link to related docs when applicable. + +Fit new content into existing structure β€” avoid introducing new top-level sections. + +πŸ™‹β€β™‚οΈ Navigation Tips + +Use the folder structure to locate the topic area first (e.g., docs/base-app/ for app guides). + +Follow naming and organization conventions from other sections for consistency. + +If you’re adding examples or new guides, reference similar files in other sections. + +πŸ“– Helpful Links + +🌐 Official Base Docs Site: https://docs.base.org/docs + +✍️ Content guidelines: content-instructions.md + +🧠 Writing style: global-tone-voice.mdx + +πŸ“Œ Formatting reference: mintlify-reference.md + +Thanks for contributing to Base docs! + + +--- + +If you want, I can also generate **a PR description template** you can use when opening your first contribution to this repo. +::contentReference[oaicite:6]{index=6}