CMR-11239-mini: Research alternatives to improve CMR documentation

[bmsultz-nasa]

Overview

What is the objective?

LLMs have a hard time processing the current CMR documentation since it is one large file. I found a way to auto-generate documentation that is divided by topic into efficient, small sections, and can still use the Clojure auto-generation architecture. This was a research ticket, so the code will not be merged.

What are the changes?

I created an npm environment in search-app/docs to match the location of api.md and site.md. The npm environment supports the Starlight integration for the Astro framework, so the static content (new documentation) and configuration files for those tools are also in the same directory. I converted the content in api.md to a new directory structure of Markdown files that creates smaller and more encapsulated documentation sections. All original documentation files have been left untouched. I also set the output directory for the new documentation to be the same as the old one: resources/public/site/docs/search. Finally, I changed several tests and other .clj routing and auto-generation files to work with the new architecture.

What areas of the application does this impact?

List impacted applications

• Auto-generation of documentation
• Feeding new documentation to NASA LLMs: LLMs can now process documentation more efficiently.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: be085466-5203-44ca-b579-d5823d8d67f1

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch CMR-11239-mini

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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