fix: swap copilot and three steps sections in getting started page#177
fix: swap copilot and three steps sections in getting started page#177amankv1234 wants to merge 3 commits into
Conversation
WalkthroughThe Getting Started section now separates GitHub Copilot instructions from manual installation steps, placing the Copilot guidance first and labeling both setup paths consistently across the documentation page and client guide. ChangesGetting Started Documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested labels: Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
landing-page/src/app/docs/page.tsx (1)
135-167: 📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick winUpdate upstream documentation to match the new order.
Swapping the Copilot callout to appear before the three-step installation creates an inconsistency with the upstream contract in
docs/client-guide.md(lines 20-36), which still presents the three-step instructions first. Please update the markdown guide to reflect this new intended order and maintain consistency across the documentation.🤖 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 `@landing-page/src/app/docs/page.tsx` around lines 135 - 167, Update the upstream documentation in docs/client-guide.md so the Copilot callout appears before the three-step installation instructions, matching the order shown in the page content. Preserve the existing wording and structure of both sections while reordering only the affected documentation blocks.
🤖 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.
Outside diff comments:
In `@landing-page/src/app/docs/page.tsx`:
- Around line 135-167: Update the upstream documentation in docs/client-guide.md
so the Copilot callout appears before the three-step installation instructions,
matching the order shown in the page content. Preserve the existing wording and
structure of both sections while reordering only the affected documentation
blocks.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 3ca94725-ab71-4100-91b2-033ee63f9c87
📒 Files selected for processing (1)
landing-page/src/app/docs/page.tsx
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
landing-page/src/app/docs/page.tsx (1)
135-171: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winExternalize the new Getting Started copy for i18n.
The added headings, Copilot instructions, and manual setup text are hardcoded directly in JSX. Move these strings into the project’s resource/translation mechanism so the new documentation remains localizable.
As per path instructions: “User-visible strings should be externalized to resource files (i18n).”
🤖 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 `@landing-page/src/app/docs/page.tsx` around lines 135 - 171, Externalize all user-visible strings in the new Getting Started section, including the AI-Agent and Manually headings, Copilot instructions, prompt URL text, completion message, three manual setup steps, and no-configuration message. Add them to the project’s existing translation resources and update the documentation page JSX to retrieve them through the established i18n mechanism, preserving the current formatting and link behavior.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.
Outside diff comments:
In `@landing-page/src/app/docs/page.tsx`:
- Around line 135-171: Externalize all user-visible strings in the new Getting
Started section, including the AI-Agent and Manually headings, Copilot
instructions, prompt URL text, completion message, three manual setup steps, and
no-configuration message. Add them to the project’s existing translation
resources and update the documentation page JSX to retrieve them through the
established i18n mechanism, preserving the current formatting and link behavior.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 167f55e9-9cd3-4923-8eb0-8b513f3877b9
📒 Files selected for processing (2)
docs/client-guide.mdlanding-page/src/app/docs/page.tsx
|
@coderabbitai |
|
Tip For best results, initiate chat on the files or code changes. The Comment image shows the dark-themed SocialShareButton docs page at
Would you like me to open a follow-up GitHub issue to track i18n adoption and later externalization of UI strings? 🐇💭 ✏️ Learnings added
|
Screenshots:
Additional Notes:
Exchanged positions of GitHub Copilot section and three steps section in the SocialShareButton landing page getting started section. Copilot section now appears above the three steps for better user flow.
Checklist
Summary by CodeRabbit