Skip to content

docs: add llms.txt and llms-full.txt#15

Open
polarweasel wants to merge 2 commits into
mainfrom
ab/llms-txt
Open

docs: add llms.txt and llms-full.txt#15
polarweasel wants to merge 2 commits into
mainfrom
ab/llms-txt

Conversation

@polarweasel
Copy link
Copy Markdown
Collaborator

@polarweasel polarweasel commented May 29, 2026

Description

Adding LLM-guidance files to match what's in our other repos.

(No need for Kind test run, these just sit at the repo root and don't get built by anything.)

Validation

  • Standard CI passes.
  • Kind integration passes, or this PR explains why it was not run.

The kind integration test is manual due to taking ~30 min to complete. When the PR is ready for review,
run Actions -> Kind Integration -> Run workflow against the copy-pr-bot generated
pull-request/<PR_NUMBER> branch. Use the default test_path for the full suite,
or narrow it only while debugging.

Passing Kind Integration run:

Checklist

  • I am familiar with the contributing guidelines in CONTRIBUTING.md.
  • Commits are signed off for DCO compliance.
  • New or existing tests cover these changes, or the PR explains why tests are not needed.
  • Documentation is updated for user-facing behavior changes.
  • Generated artifacts are updated when applicable, such as OpenAPI specs,
    docs screenshots, or Helm/rendered outputs.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive repository documentation (full and concise overviews) describing the project, system architecture, components, deployment/installer model, data/control paths, usage and development commands, documentation map, technology stack reference, and governance/release/security/license metadata for NVIDIA Config Manager.

Review Change Stack

Signed-off-by: Alex Ball <aball@nvidia.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2026

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: 23567264-a129-4a80-b199-4177aaa2aa35

📥 Commits

Reviewing files that changed from the base of the PR and between fa210e7 and 1c77a3d.

📒 Files selected for processing (1)
  • llms-full.txt
💤 Files with no reviewable changes (1)
  • llms-full.txt

📝 Walkthrough

Walkthrough

This pull request adds two documentation files to provide LLM-accessible project context. llms.txt is a quick project summary covering the Config Manager's components, key concepts, and technology stack. llms-full.txt is a comprehensive reference containing repository structure, architecture diagrams, deployment information, domain areas, documentation index, development commands, and governance metadata.

Changes

Project Documentation for LLM Context

Layer / File(s) Summary
LLM context documentation
llms.txt, llms-full.txt
Adds concise and comprehensive project overview files. llms.txt summarizes components, concepts, documentation links, and tech stack (Python/uv, FastAPI, Temporal, Nautobot, NATS/JetStream, PostgreSQL, Helm/Kubernetes, React/Next.js, Fern). llms-full.txt provides detailed repository layout, service architecture with event/data flows, installer and deployment model, core domain areas, development/testing commands, related projects, and governance/license metadata.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Two scrolls of wisdom, side by side,
One quick, one deep—a helpful guide!
For robots reading code and dreams,
The Config Manager's context gleams.
Documentation hops along with glee! 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely summarizes the main change: adding two LLM-guidance documentation files (llms.txt and llms-full.txt) to the repository root.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ab/llms-txt

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@llms-full.txt`:
- Around line 150-157: Update the External Related Projects list to use correct
public repository names or mark private/missing repos: replace
`nautobot-broker-nats` with the known public slug `NVIDIA/nautobot-broker-nats`,
verify whether `nv-config-manager-templates` is misnamed (search orgs or repos
for similar slugs and update the entry to the correct repo name or remove/label
it as private), and do the same for `nautobot-plugin-nv-config-manager` (find
the correct slug/org or mark it as private/non-public); ensure each bullet uses
the exact repo slug or includes a note that the repository is
private/unavailable.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 6cbc71dc-e99c-4fbb-b5a7-a3621ac60d37

📥 Commits

Reviewing files that changed from the base of the PR and between 1e7cfc2 and fa210e7.

📒 Files selected for processing (2)
  • llms-full.txt
  • llms.txt

Comment thread llms-full.txt Outdated
Signed-off-by: Alex Ball <aball@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.

2 participants