Skip to content

docs: organize docs into sections#267

Merged
dmitsh merged 1 commit into
mainfrom
ds-docs
Apr 17, 2026
Merged

docs: organize docs into sections#267
dmitsh merged 1 commit into
mainfrom
ds-docs

Conversation

@dmitsh
Copy link
Copy Markdown
Collaborator

@dmitsh dmitsh commented Apr 17, 2026

Reorg the docs to fit fern structure

@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented Apr 17, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@dmitsh dmitsh requested review from ravisoundar and resker April 17, 2026 19:18
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 17, 2026

Greptile Summary

This PR reorganizes the documentation to fit the Fern docs structure by introducing docs/index.yml as the Fern navigation manifest, trimming README.md to a minimal intro with "Learn more" links, and extracting content into dedicated docs/overview.md and docs/architecture.md pages. All file paths in docs/index.yml resolve correctly, and fern/docs.yml already points at ../docs/index.yml.

Confidence Score: 5/5

Safe 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

Filename Overview
README.md Stripped down to a minimal intro with "Learn more" links pointing correctly to docs/overview.md, docs/architecture.md, and docs/api.md.
docs/index.yml New Fern navigation file; all referenced paths (overview.md, architecture.md, api.md, providers/, engines/) exist and are correct.
docs/overview.md New top-level overview page migrated from README; one P2 issue — plain-text "API.md" reference on line 28 should be a hyperlink.
docs/architecture.md New architecture page; image path assets/design.png resolves correctly relative to docs/architecture.md to docs/assets/design.png.
docs/api.md Configuration and API reference page; content unchanged, now registered in the Fern navigation index.

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
Loading

Reviews (2): Last reviewed commit: "docs: organize docs into sections" | Re-trigger Greptile

Comment thread docs/architecture.md Outdated
Signed-off-by: Dmitry Shmulevich <dshmulevich@nvidia.com>
@dmitsh dmitsh merged commit 94199ae into main Apr 17, 2026
3 checks passed
@dmitsh dmitsh deleted the ds-docs branch April 17, 2026 20:26
resker added a commit to resker/topograph that referenced this pull request Apr 18, 2026
… 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>
resker added a commit to resker/topograph that referenced this pull request Apr 18, 2026
… 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>
dmitsh pushed a commit that referenced this pull request Apr 18, 2026
… 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant