Skip to content

Further clean up of documentation - #64

Merged
ebalduf merged 2 commits into
mainfrom
documentation_cleanup
Sep 3, 2026
Merged

Further clean up of documentation#64
ebalduf merged 2 commits into
mainfrom
documentation_cleanup

Conversation

@ebalduf

@ebaldufebalduf commented Sep 3, 2026

Copy link
Copy Markdown
Contributor
  1. Remove 'copy' of README.md called overview.md and just use the
    README.md
  2. Clean up the links in README.md so they work from rendered Fern.
  3. Point the README.md docs section at the rendered Fern docs, which
    include all of the Fleet-Intelligence docs.

Summary by CodeRabbit

  • Documentation
    • Updated documentation links to include hosted docs, platform guidance, the OpenAPI contract, contribution guidelines, security information, licensing, and support resources.
    • Updated documentation navigation to use the README as the overview and added a Contributing section.
    • Removed the standalone overview page, including its CLI, SDK, installation, authentication, and AI skills setup content.
    • Improved versioned documentation coverage for repository overview and contribution pages.

1) Remove 'copy' of README.md called overview.md and just use the
README.md
2) Clean up the links in README.md so they work from rendered Fern.
3) Point the README.md docs section at the rendered Fern docs, which
include all of the Fleet-Intelligence docs.
Signed-off-by: Ed Balduf <ebalduf@nvidia.com>
@coderabbitai

coderabbitaiBot commented Sep 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: a17e0b28-c740-4367-935a-a8c2739a24bc

📥 Commits

Reviewing files that changed from the base of the PR and between 1bb3443 and b68bfd5.

📒 Files selected for processing (3)
  • .github/workflows/fern-docs-ci.yml
  • fern/.gitignore
  • scripts/docs-fetch-versions.py

Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review.


📝 Walkthrough

Walkthrough

The README now links to hosted documentation and repository resources. The former overview page was removed. Fern documentation uses the README for Overview and adds a Contributing page. Versioned documentation staging now includes root repository pages.

Changes

Documentation navigation

Layer / File(s)Summary
Documentation entry points
README.md, docs/overview.md, fern/docs.yml
The README adds links for documentation, the OpenAPI contract, Contributing, Security, and License. The removed overview page is replaced in navigation by the README. Fern adds a Contributing navigation entry.
Versioned root-page staging
scripts/docs-fetch-versions.py
The version-fetching script retrieves README.md and CONTRIBUTING.md from tags, applies MDX fixes, maps them to staged page names, and includes available pages in generated output.
Documentation CI support
.github/workflows/fern-docs-ci.yml, fern/.gitignore
Fern Docs CI now watches README.md and CONTRIBUTING.md. Fern-generated directories and dependencies are ignored.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk:⚪ Minimal · up to b68bf

This updates documentation entry points and versioned-document staging without an identified correctness, security, or availability risk. The change is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the documentation cleanup, which is the main purpose of the pull request. It is broad but still clear and relevant.
Docstring Coverage✅ PassedDocstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 1 files. (2 skipped: 2 …
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 1 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch documentation_cleanup

Comment @coderabbitai help to get the list of available commands.

And add .gitignore for versions dierctory
Signed-off-by: Ed Balduf <ebalduf@nvidia.com>
@ebalduf
ebalduf merged commit d9b7c3c into mainSep 3, 2026
8 checks passed
@ebalduf
ebalduf deleted the documentation_cleanup branch September 3, 2026 22:48
Sign up for freeto 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.

2 participants

@ebalduf@jingxiang-z