|  | 
|  | 1 | +# V2 API Documentation Context | 
|  | 2 | + | 
|  | 3 | +## Project Overview | 
|  | 4 | +This directory contains the experimental user-facing documentation for Filecoin's V2 API. The purpose of this work is to maintain the documentation in source control for easier team review before publishing to external platforms like Notion. | 
|  | 5 | + | 
|  | 6 | +## Source Information | 
|  | 7 | +- Original source: https://filoznotebook.notion.site/Filecoin-V2-APIs-1d0dc41950c1808b914de5966d501658 | 
|  | 8 | +- This documentation describes experimental V2 APIs that are subject to change | 
|  | 9 | + | 
|  | 10 | +## Workflow | 
|  | 11 | +1. (If this hasn't already been don) Copy updates from Notion into this repository | 
|  | 12 | +2. Make changes, likely using Claude Code by pointing to to local changes or changes in a PR. | 
|  | 13 | +2. Regenerate the table of contents if you've added or modified sections | 
|  | 14 | +3. Submit changes for team review via pull request | 
|  | 15 | +4. After approval, publish updated content back to Notion | 
|  | 16 | + | 
|  | 17 | +**Important**: Always regenerate the table of contents before committing changes to ensure it accurately reflects the document structure. The table of contents is comprehensive and includes all sections of the document, helping readers navigate the content.  It also helps give an overview in the diff of what content is being added/changed and where in the document.   | 
|  | 18 | + | 
|  | 19 | +## Key Files | 
|  | 20 | +- `api-v2-experimental.md`: The main user facing documentation file that is copied to Notion. | 
|  | 21 | +- Related code: `api/v2api/full.go` (API implementation) | 
|  | 22 | +- Related code: `chain/types/tipset_selector.go` (Key types) | 
|  | 23 | +- Generated docs: `documentation/en/api-v2-unstable-methods.md` | 
|  | 24 | + | 
|  | 25 | +## Commands | 
|  | 26 | + | 
|  | 27 | +### Regenerating the Table of Contents | 
|  | 28 | +For Claude to regenerate the table of contents: | 
|  | 29 | +1. Extract all headers from the document using grep: | 
|  | 30 | +```bash | 
|  | 31 | +grep -n '^#\|^##\|^###\|^####' api-v2-experimental.md | 
|  | 32 | +``` | 
|  | 33 | +2. Use this information to update the Table of Contents section, ensuring all headers are properly nested according to their level and linked. | 
|  | 34 | + | 
|  | 35 | +Humans in their IDE can use [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one). | 
0 commit comments