docs: single-source starter prompt in Markdown#6894
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (8)
🚧 Files skipped from review as they are similar to previous changes (4)
📝 WalkthroughWalkthroughThe PR makes ChangesStarter Prompt Documentation
Estimated code review effort: 3 (Moderate) | ~25 minutes Suggested labels: Sequence Diagram(s)sequenceDiagram
participant Source as starter-prompt.md
participant Generator as generate-starter-prompt.ts
participant Docs as Documentation workflows
participant Fern as Fern validation
Source->>Generator: read and validate Markdown
Generator->>Docs: write generated MDX
Docs->>Fern: run docs:validate
Fern-->>Docs: validation result
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage remains at 96%, unchanged from the TypeScript / code-coverage/cliThe overall coverage in the Show a code coverage summary of the most impacted files.
Updated |
|
🌿 Preview your docs: https://nvidia-preview-pr-6894.docs.buildwithfern.com/nemoclaw |
PR Review Advisor — InformationalAdvisor assessment: Informational / high confidence Model lanes
Nemotron output stays in workflow artifacts and does not change the assessment above. E2E guidanceAdvisory only. E2E / PR Gate selects and runs jobs independently. Recommended E2E: 1 optional E2E recommendation
This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge. |
miyoungc
added
area: onboarding
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 `@docs/CONTRIBUTING.md`:
- Around line 116-117: Update the documentation text around the
downstream-consumer raw URL so each sentence occupies one Markdown line and ends
with a period. Keep the URL example intact, either placing the entire sentence
on one line or making the URL introduction a separate complete sentence.
🪄 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: e4cad1ef-7fbc-48dc-bc06-02a08eeb6bdb
📒 Files selected for processing (17)
.github/workflows/docs-preview-pr.yaml.github/workflows/docs-publish-public.yaml.github/workflows/docs-publish-staging.yaml.pre-commit-config.yamldocs/CONTRIBUTING.mddocs/_components/StarterPromptButton.tsxdocs/get-started/quickstart-hermes.mdxdocs/get-started/quickstart-langchain-deepagents-code.mdxdocs/get-started/quickstart.mdxdocs/index.mdxdocs/resources/agent-skills.mdxdocs/resources/starter-prompt.mdpackage.jsonscripts/checks/local-credential-helper-pin.tsscripts/generate-starter-prompt.tstest/local-credential-helper-pin.test.tstest/starter-prompt-docs.test.ts
💤 Files with no reviewable changes (2)
- docs/_components/StarterPromptButton.tsx
- test/local-credential-helper-pin.test.ts
| Downstream consumers can pin the source with a raw URL such as | ||
| `https://raw.githubusercontent.com/NVIDIA/NemoClaw/<commit-sha>/docs/resources/starter-prompt.md`. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Keep one sentence per Markdown line.
Lines 116-117 split one sentence across two lines. Keep the sentence on one line or introduce the URL as a separate sentence.
As per coding guidelines, Markdown documentation must use one sentence per line and end every sentence with a period.
🤖 Prompt for 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.
In `@docs/CONTRIBUTING.md` around lines 116 - 117, Update the documentation text
around the downstream-consumer raw URL so each sentence occupies one Markdown
line and ends with a period. Keep the URL example intact, either placing the
entire sentence on one line or making the URL introduction a separate complete
sentence.
Source: Coding guidelines
There was a problem hiding this comment.
🧹 Nitpick comments (1)
test/starter-prompt-docs.test.ts (1)
143-149: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick winAvoid using the production extractor as the sole test oracle.
readStarterPrompt()derives expected content through the same parsing path used by generation. If that parser regresses, the generator and these assertions can remain mutually consistent while producing the wrong prompt. Add fixed, behavior-level assertions for stable generated MDX and credential-helper content independently ofextractStarterPromptMarkdown.As per path instructions, tests should validate observable behavior rather than implementation-derived output.
🤖 Prompt for 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. In `@test/starter-prompt-docs.test.ts` around lines 143 - 149, Update readStarterPrompt and its tests so expected starter-prompt content is not derived solely through extractStarterPromptMarkdown. Add fixed behavior-level assertions for stable generated MDX and credential-helper content, while retaining assertions that validate the observable output independently of the production extractor.Source: Path instructions
🤖 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.
Nitpick comments:
In `@test/starter-prompt-docs.test.ts`:
- Around line 143-149: Update readStarterPrompt and its tests so expected
starter-prompt content is not derived solely through
extractStarterPromptMarkdown. Add fixed behavior-level assertions for stable
generated MDX and credential-helper content, while retaining assertions that
validate the observable output independently of the production extractor.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: b5dfc55b-1957-4e47-8490-bc3fdb1c85fa
📒 Files selected for processing (1)
test/starter-prompt-docs.test.ts
4 participants
Summary
Moves the Starter Prompt from a custom React component into a canonical Markdown file that downstream Brev launchables and playbooks can pin by commit SHA. Fern now generates a reusable native
Promptcomponent with a visible preview and copy control from that single source.Changes
docs/resources/starter-prompt.mdas the canonical downstream-consumable prompt.docs/_build/StarterPrompt.generated.mdxand wired it into docs checks and variant generation.docs:prepareanddocs:validatecommands, and wired them into local builds plus Fern preview, staging, and public publish workflows.Promptcomponent across the home, quickstart, and agent-skills pages.Type of Change
Quality Gates
Verification
Signed-off-by:line and every commit appears asVerifiedin GitHubpre-commit,commit-msg, andpre-pushhooks passed, ornpm run check:diffpassed when hooks were skipped or unavailablenpm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — not applicable to this focused docs-generation changenpm run docsbuilds without warnings (doc changes only) — passed with 0 errors and 1 pre-existing contrast warningSigned-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit