Conversation
Greptile SummaryThis PR reorganizes the documentation to fit the Fern docs structure by introducing Confidence Score: 5/5Safe to merge — purely a docs reorganization with all links resolving correctly. All five changed files are documentation only. The Fern navigation index references existing files. The single finding is a P2 style issue (plain-text API.md reference), which does not block merge. docs/overview.md — one plain-text link reference on line 28 should be a hyperlink. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["fern/docs.yml"] -->|"path: ../docs/index.yml"| B["docs/index.yml"]
B --> C["Getting Started"]
B --> D["Architecture"]
B --> E["Providers"]
B --> F["Engines"]
C --> G["docs/overview.md"]
D --> H["docs/architecture.md"]
D --> I["docs/api.md"]
E --> J["aws / gcp / oci / nebius\ninfiniband / netq / dra"]
F --> K["slurm / k8s / slinky"]
L["README.md"] -->|"Learn more"| G
L -->|"Learn more"| H
L -->|"Learn more"| I
Reviews (2): Last reviewed commit: "docs: organize docs into sections" | Re-trigger Greptile |
Signed-off-by: Dmitry Shmulevich <dshmulevich@nvidia.com>
… stale references Builds on the agent-guidance pattern established in NVIDIA#253, adding the explicit evaluation guidance that was deferred during that PR's review. Adds: - New "Documentation Impact Evaluation" subsection in §5 with a table mapping change types to the docs that should be updated in the same PR (provider, engine, chart template, values schema, label/annotation key, API endpoint, config schema, invariant, Makefile/layout) - New pre-push checklist item: "Documentation impact evaluated per the table above" - New anti-pattern row flagging AGENTS.md drift when an AGENTS.md-described surface changes without updating both synced files in the same PR Refreshes references made stale by NVIDIA#267 (docs reorg): - Repository map entry for docs/ now lists overview.md, architecture.md, api.md explicitly - "Adding a new provider" step 5 points at docs/overview.md instead of README.md for the provider list / scenario table - "When in doubt" pointer to "Choosing a Provider" table updated to docs/overview.md; adds docs/api.md pointer for API/config schema - Simplifies the pre-push checklist (specific provider/engine doc items roll up into the new Documentation Impact Evaluation table) - Prunes README.md out of the registry-wiring anti-pattern (the registry update is the load-bearing concern; doc updates are covered by the new evaluation table) Both files stay byte-identical from line 6 onward. Signed-off-by: Rob Esker <resker@nvidia.com>
… stale references Builds on the agent-guidance pattern established in NVIDIA#253, adding the explicit evaluation guidance that was deferred during that PR's review. Adds: - New "Documentation Impact Evaluation" subsection in §5 with a table mapping change types to the docs that should be updated in the same PR (provider, engine, chart template, values schema, label/annotation key, API endpoint, config schema, invariant, Makefile/layout) - New pre-push checklist item: "Documentation impact evaluated per the table above" - New anti-pattern row flagging AGENTS.md drift when an AGENTS.md-described surface changes without updating both synced files in the same PR Refreshes references made stale by NVIDIA#267 (docs reorg): - Repository map entry for docs/ now lists overview.md, architecture.md, api.md explicitly - "Adding a new provider" step 5 points at docs/overview.md instead of README.md for the provider list / scenario table - "When in doubt" pointer to "Choosing a Provider" table updated to docs/overview.md; adds docs/api.md pointer for API/config schema - Simplifies the pre-push checklist (specific provider/engine doc items roll up into the new Documentation Impact Evaluation table) - Prunes README.md out of the registry-wiring anti-pattern (the registry update is the load-bearing concern; doc updates are covered by the new evaluation table) Both files stay byte-identical from line 6 onward. Signed-off-by: Rob Esker <resker@nvidia.com>
… stale references (#269) Builds on the agent-guidance pattern established in #253, adding the explicit evaluation guidance that was deferred during that PR's review. Adds: - New "Documentation Impact Evaluation" subsection in §5 with a table mapping change types to the docs that should be updated in the same PR (provider, engine, chart template, values schema, label/annotation key, API endpoint, config schema, invariant, Makefile/layout) - New pre-push checklist item: "Documentation impact evaluated per the table above" - New anti-pattern row flagging AGENTS.md drift when an AGENTS.md-described surface changes without updating both synced files in the same PR Refreshes references made stale by #267 (docs reorg): - Repository map entry for docs/ now lists overview.md, architecture.md, api.md explicitly - "Adding a new provider" step 5 points at docs/overview.md instead of README.md for the provider list / scenario table - "When in doubt" pointer to "Choosing a Provider" table updated to docs/overview.md; adds docs/api.md pointer for API/config schema - Simplifies the pre-push checklist (specific provider/engine doc items roll up into the new Documentation Impact Evaluation table) - Prunes README.md out of the registry-wiring anti-pattern (the registry update is the load-bearing concern; doc updates are covered by the new evaluation table) Both files stay byte-identical from line 6 onward. Signed-off-by: Rob Esker <resker@nvidia.com>
Reorg the docs to fit fern structure