Feature/docs getting started #12

nedhmn · 2025-05-19T21:22:09Z

Summary by CodeRabbit

New Features
- Introduced metadata files for documentation sections to provide page titles and theme options.
- Added comprehensive guides for installation, configuration, running the app, and using the ruling question feature.
- Expanded the documentation introduction with project overview, key features, technologies used, and an explanation of the Retrieval-Augmented Generation (RAG) methodology.
Documentation
- Added detailed setup and user guides to improve onboarding and usability.
- Enhanced the introduction page with visual previews and technical explanations.
Chores
- Updated TypeScript configuration to recognize new metadata files.
Refactor
- Improved page metadata titles to include a global title suffix for consistency.
Tests
- Removed an obsolete test script related to Pinecone index statistics.

coderabbitai · 2025-05-19T21:22:15Z

Caution

Review failed

The pull request is closed.

"""

Walkthrough

This update introduces new documentation files for installation, configuration, usage, and guides in the documentation app, expands the introduction page, and adds metadata configuration files to organize documentation structure. It also updates the metadata generation logic to append a global title suffix, adjusts TypeScript configuration to include metadata files, adds environment example files for web and seeder apps, and removes an unused test script.

Changes

File(s)	Change Summary
apps/docs/app/[[...mdxPath]]/page.tsx	Modified the `generateMetadata` function to append a global title suffix from a shared constant to the page title, preserving all other metadata fields.
apps/docs/content/_meta.js apps/docs/content/getting-started/_meta.js	Added metadata configuration files exporting objects that map documentation sections and pages to human-readable titles and theme options.
apps/docs/content/getting-started/installation.mdx apps/docs/content/getting-started/configuration.mdx apps/docs/content/getting-started/running-the-app.mdx	Added new markdown documentation files providing guides for installation, configuration, and running the application.
apps/docs/content/guides/answering-ruling-questions.mdx	Added a new guide markdown file explaining how to use the application to answer ruling questions within the Goat Format.
apps/docs/content/index.mdx	Expanded and restructured the documentation introduction page, adding sections for features, technologies, and the RAG methodology.
apps/docs/tsconfig.json	Updated TypeScript configuration to include the `content/_meta.js` file for processing or recognition by the compiler.
packages/seeder/src/test.ts	Deleted an unused test script that fetched and logged Pinecone index statistics.
apps/web/.env.example packages/seeder/.env.example	Added example environment variable files defining configuration placeholders for OpenAI and Pinecone integration for both web and seeder components.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsPage
    participant METADATA

    User->>DocsPage: Request page
    DocsPage->>METADATA: Import global metadata
    DocsPage->>DocsPage: generateMetadata()
    DocsPage->>DocsPage: Combine page metadata with METADATA.title
    DocsPage-->>User: Serve page with updated metadata title

"""

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a55daac and e7c8998.

📒 Files selected for processing (3)

README.md (1 hunks)
apps/web/.env.example (1 hunks)
packages/seeder/.env.example (1 hunks)

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (5)

apps/docs/content/getting-started/running-the-app.mdx (2)
16-18: Unify code block attributes for consistency.

The code fence uses “```bash copy” without a filename, whereas other guides leverage filename="..." copy. To provide a consistent copy-button experience, either:
Drop the copy attribute for simple commands:
docker compose up --build
Or include a filename hint if you want to show one:
docker compose up --build
44-45: Enhance image alt text for accessibility.

The alt text YGO Ruling Chatbot preview is generic. Consider making it more descriptive—e.g., “Screenshot of the app UI running at http://localhost:3000 after Docker Compose startup”—to improve accessibility for screen readers.
apps/docs/content/guides/answering-ruling-questions.mdx (1)

23-24: Use a more relevant screenshot or update alt text.

This guide focuses on asking rulings questions, but the image is the generic preview. Consider replacing it with a screenshot showing card selection and chat input, or at least update the alt text to reflect what the current image depicts.

apps/docs/content/index.mdx (2)

15-19: Refine “Turborepo Monorepo” phrasing.

The label “Turborepo Monorepo” is redundant. A clearer option might be “Monorepo management with Turborepo” to convey the benefit succinctly.

46-47: Improve external link text.

Rather than “Here’s a fantastic blog,” use descriptive link text such as “Learn more about RAG” so users know what to expect when clicking. This enhances clarity and accessibility.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f5e182e and a55daac.

⛔ Files ignored due to path filters (1)

apps/docs/public/introduction-preview.gif is excluded by !**/*.gif

📒 Files selected for processing (10)

apps/docs/app/[[...mdxPath]]/page.tsx (2 hunks)
apps/docs/content/_meta.js (1 hunks)
apps/docs/content/getting-started/_meta.js (1 hunks)
apps/docs/content/getting-started/configuration.mdx (1 hunks)
apps/docs/content/getting-started/installation.mdx (1 hunks)
apps/docs/content/getting-started/running-the-app.mdx (1 hunks)
apps/docs/content/guides/answering-ruling-questions.mdx (1 hunks)
apps/docs/content/index.mdx (1 hunks)
apps/docs/tsconfig.json (1 hunks)
packages/seeder/src/test.ts (0 hunks)

💤 Files with no reviewable changes (1)

packages/seeder/src/test.ts

🧰 Additional context used

🧬 Code Graph Analysis (1)

apps/docs/app/[[...mdxPath]]/page.tsx (2)

apps/docs/app/layout.tsx (1)

metadata (9-12)

apps/docs/lib/constants.ts (1)

METADATA (1-8)

🪛 LanguageTool

apps/docs/content/getting-started/configuration.mdx

[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...nv.local files: - **OPENAI_API_KEY`**: Your OpenAI API key. Required. - **...