docs: Add documentation review guidance#3495
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
polarweasel
left a comment
polarweasel
left a comment
There was a problem hiding this comment.
Added some changes and some questions...
|
|
||
| - **Metric catalogue:** A metric is not documented until its HELP text, emitted series, and generated catalogue agree. | ||
|
|
||
| - Treat metric HELP text and `docs/observability/core_metrics.md` as generated |
There was a problem hiding this comment.
But isn't the HELP text human-written?
| - New or moved public pages must be present in `docs/index.yml`, and changed | ||
| public paths need redirects in `fern/docs.yml`. |
There was a problem hiding this comment.
Running fern docs md check and fern check can surface issues with moved pages, and suggest redirects. Not sure every agent will have a Fern token, though.
| - For Fern-published pages, run `fern check` and inspect the PR preview; if it | ||
| is unavailable, use `(cd fern && fern docs dev)`. |
There was a problem hiding this comment.
Fern check doesn't generate a preview. If you want to include preview-generation steps, do it with an --id flag, and make sure to delete the preview when finished.
2 participants
No description provided.