|
| 1 | +# AGENTS.md |
| 2 | + |
| 3 | +This file is for contributors and coding agents working in this repository. |
| 4 | +It captures how documentation is organized, written, and maintained in `nillion-docs`. |
| 5 | + |
| 6 | +## Repo Overview |
| 7 | + |
| 8 | +- Framework: Docusaurus v3 |
| 9 | +- Docs root: `docs/` |
| 10 | +- Blog root: `blog/` |
| 11 | +- Static assets: `static/` (especially `static/img/`) |
| 12 | +- Sidebar config: |
| 13 | + - `sidebars.js` |
| 14 | + - `sidebar-learn.js` |
| 15 | + - `sidebar-build.js` |
| 16 | + - `sidebar-community.js` |
| 17 | + - `sidebar-blacklight.js` |
| 18 | + |
| 19 | +## Documentation Approach In This Repo |
| 20 | + |
| 21 | +- Write for builders first: practical, task-oriented, and implementation-focused. |
| 22 | +- Prefer clear build flows over conceptual prose: |
| 23 | + - prerequisites |
| 24 | + - step-by-step instructions |
| 25 | + - runnable commands/code |
| 26 | + - troubleshooting/next steps |
| 27 | +- Explicitly recommend preferred paths when relevant (for example, UI/recommended workflow vs low-level alternatives). |
| 28 | +- Use Nillion product language consistently: |
| 29 | + - Blind Computer |
| 30 | + - Blacklight |
| 31 | + - Private Storage (nilDB) |
| 32 | + - Private LLMs (nilAI) |
| 33 | + - Private Compute / Confidential Compute (nilCC) |
| 34 | + |
| 35 | +## Authoring Conventions |
| 36 | + |
| 37 | +### 1) File Type |
| 38 | + |
| 39 | +- Use `.md` for mostly markdown pages. |
| 40 | +- Use `.mdx` when using React/Docusaurus components or custom JSX layouts. |
| 41 | +- Note: this repo already uses MDX features in both `.md` and `.mdx` files (imports/components at top are common). |
| 42 | + |
| 43 | +### 2) Titles and Frontmatter |
| 44 | + |
| 45 | +- Most hand-authored docs pages rely on `# H1` and often omit frontmatter. |
| 46 | +- Use frontmatter when needed (for example custom `title`, `description`, `sidebar_label`, or blog metadata). |
| 47 | +- Blog posts should use frontmatter with fields like: |
| 48 | + - `title` |
| 49 | + - `description` |
| 50 | + - `slug` |
| 51 | + - `authors` |
| 52 | + - `tags` |
| 53 | + - `image` |
| 54 | + |
| 55 | +### 3) Page Structure Patterns |
| 56 | + |
| 57 | +Common structure used in quickstarts and guides: |
| 58 | + |
| 59 | +1. Intro / what the guide does |
| 60 | +2. Prerequisites |
| 61 | +3. Numbered steps |
| 62 | +4. Verification or expected output |
| 63 | +5. Next steps / related docs |
| 64 | + |
| 65 | +Common section names in this repo include: |
| 66 | +- `What You'll Build` |
| 67 | +- `What You'll Learn` |
| 68 | +- `Prerequisites` |
| 69 | +- `Project Setup` |
| 70 | +- `Next Steps` |
| 71 | + |
| 72 | +### 4) Links |
| 73 | + |
| 74 | +- Use root-relative internal links (example: `/blind-computer/build/storage/overview`). |
| 75 | +- Use explicit external links for tools, repos, and portals. |
| 76 | +- Keep links actionable and specific (direct users to exact guide/section when possible). |
| 77 | + |
| 78 | +### 5) Code Blocks |
| 79 | + |
| 80 | +- Always set a language for fenced code blocks when possible (`bash`, `typescript`, `python`, `yaml`, etc.). |
| 81 | +- Use `reference showGithubLink` blocks when pointing to canonical source examples in external repos. |
| 82 | +- Keep commands copy-paste friendly. |
| 83 | + |
| 84 | +### 6) MDX Components Used Here |
| 85 | + |
| 86 | +Commonly used components: |
| 87 | + |
| 88 | +- Docusaurus: |
| 89 | + - `Tabs` |
| 90 | + - `TabItem` |
| 91 | +- Local components: |
| 92 | + - `CTABanner` |
| 93 | + - `ThumbsUpDown` |
| 94 | + - `FeatureSection` |
| 95 | + - `ToolFeatureItem` |
| 96 | + - `AddNetworkButton` (MetaMask network add UX) |
| 97 | + - `IframeVideo` |
| 98 | + |
| 99 | +If reusing a component, check its props in: |
| 100 | +- `src/components/CTABanner/index.js` |
| 101 | +- `src/components/ThumbsUpDown/index.js` |
| 102 | +- `src/components/ToolFeatureItem/index.js` |
| 103 | +- `src/components/MetamaskConnect/index.js` |
| 104 | +- `src/components/IframeVideo/index.js` |
| 105 | + |
| 106 | +### 7) Admonitions and Callouts |
| 107 | + |
| 108 | +Use Docusaurus admonitions for guidance and guardrails: |
| 109 | +- `:::tip` |
| 110 | +- `:::info` |
| 111 | +- `:::note` |
| 112 | +- `:::warning` |
| 113 | + |
| 114 | +Prefer concise callouts that directly unblock the user. |
| 115 | + |
| 116 | +### 8) Images and Embeds |
| 117 | + |
| 118 | +- Store assets in `static/img/`. |
| 119 | +- Reference images with site-relative paths like `/img/<file>`. |
| 120 | +- Use descriptive alt text. |
| 121 | +- This repo sometimes uses inline HTML/JSX layout (`<div>`, `<img>`, `<iframe>`) for side-by-side walkthrough sections. |
| 122 | + |
| 123 | +## Sidebar and Navigation Rules |
| 124 | + |
| 125 | +- New docs do not automatically appear in navigation; update relevant sidebar file. |
| 126 | +- Choose the sidebar file by section: |
| 127 | + - Blacklight docs -> `sidebar-blacklight.js` |
| 128 | + - Blind Computer Learn/Build/Tools -> `sidebar-learn.js` or `sidebar-build.js` |
| 129 | + - Community -> `sidebar-community.js` |
| 130 | +- `sidebars.js` composes all section sidebars. |
| 131 | + |
| 132 | +## Build and Validation |
| 133 | + |
| 134 | +Use: |
| 135 | + |
| 136 | +```bash |
| 137 | +yarn start |
| 138 | +``` |
| 139 | + |
| 140 | +and for verification: |
| 141 | + |
| 142 | +```bash |
| 143 | +yarn build |
| 144 | +``` |
| 145 | + |
| 146 | +`docusaurus.config.js` is strict on broken links (`onBrokenLinks: 'throw'`, `onBrokenMarkdownLinks: 'throw'`), so link integrity must be maintained. |
| 147 | + |
| 148 | +## Style and Tone Guardrails |
| 149 | + |
| 150 | +- Keep explanations concrete and implementation-oriented. |
| 151 | +- Prefer short paragraphs and scannable lists. |
| 152 | +- Avoid unnecessary jargon when a direct instruction is possible. |
| 153 | +- If describing a sequence, use numbered steps. |
| 154 | +- If a flow has options (e.g., UI vs API, Python vs TypeScript), use tabs. |
| 155 | + |
| 156 | +## When Updating Docs |
| 157 | + |
| 158 | +Checklist: |
| 159 | + |
| 160 | +1. Update the target doc page(s). |
| 161 | +2. Update relevant sidebar file if navigation should change. |
| 162 | +3. Verify internal links and anchors. |
| 163 | +4. Ensure commands/code snippets are runnable and current. |
| 164 | +5. Run `yarn build` before finalizing substantial changes. |
| 165 | + |
0 commit comments