docs: add "safe" tag to V2 API documentation#13051
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Please update the PR title to match https://github.com/filecoin-project/lotus/blob/master/CONTRIBUTING.md#pr-title-conventions
masih
changed the title
github-actions
Bot
dismissed
their stale review
PR title now matches the required format.
github-project-automation
Bot
moved this from ⌨️ In Progress
to ✔️ Approved by reviewer
in FilOz
|
GitHub has it's own ToC system (a button in top right of any markdown file opened in rich mode). |
Yeah, agreed. I made more comments about the purpose of having he ToC in the doc. It is only to help with reviewing structural changes. When copying to Notion, I'll remove it and let Notion generate one. I also added comments about using IDE extensions like Markdown All in One to generate table of contents. |
|
@masih : I don't think required to review again, but I did make a few changes as a result of incorporating feedback. |
This makes it easier to see what content sections are being changed/added in future diffs.
…:\n- Safe tag to TipSetSelector options\n- Documentation about 200 epochs behind head placement\n- Updated comprehensive table of contents to include new sections
…ation tracking item
- Removed bad recommendations for handling when need consistent state - Fixed mermaid diagram - Made clear this doc isn't the permanent home
Fixed formatting errors. Added docs about the table of contents.
BigLep
force-pushed
the
docs/v2-api-safe-tag
branch
from
ef44d3c to
254f791
Compare
github-project-automation
Bot
moved this from ✔️ Approved by reviewer
to 🎉 Done
in FilOz
3 participants
Adds documentation for the new "safe" tag introduced in PR #13034. I didn't push these changes directly to https://filoznotebook.notion.site/Filecoin-V2-APIs-1d0dc41950c1808b914de5966d501658 because I wanted to get review (and setup a process for easier review of future changes).
The first commit is what Notion exports. I mostly used Claude Code to generate the changes after that. I pointed it at #13034 and https://github.com/filecoin-project/lotus/blob/3c5aaee7ddeac4c32b8ecdce00c1f5a5d5c0981d/documentation/en/api-v2-unstable-methods.md and asked to get updates accounting for the "safe" tag. I noticed at different points that Claude and Gemini would try and do other Markdown cleanup. I tried to get that separated into separate commits.
To make this quicker to update in the future, I started a CLAUDE.me file where we can give context.
After Claude Code was done, I fed the results to Google AI Studio with Gemini 2.5 Pro since from my quick checking it was looking to provide even better results. I did some curation of its changes, but that is the last commit. We can reject those changes if they feel too drastic.
I also found it useful to generate/update a table of contents as I was going along so I could structurally check/see what was being added. (This is currently a manual step to update the table of contents (i.e., ask LLM to do it). I don't have any scripting or tooling doing it automatically.)
If/when this gets approved, I'd plan on manually copying the merged content back to https://filoznotebook.notion.site/Filecoin-V2-APIs-1d0dc41950c1808b914de5966d501658 for now.