docs: add index page and move instructions to site

[joshunrau]

Summary by CodeRabbit

• Documentation

  • Introduced a new documentation file for the Douglasneuroinformatics UI Library, including a welcome message and an overview of the library.
  • Updated the main project overview to direct users to comprehensive online documentation for setup and usage details.

• New Features

  • Enhanced the documentation interface with support for Markdown files, improving accessibility and user experience.

• Chores

  • Added a new dependency for Storybook documentation capabilities.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new documentation file for the UI library into Storybook and update the Storybook configuration to include documentation support through the @storybook/addon-docs. The README file has been restructured to remove direct installation instructions in favor of external documentation links, and a new dependency for Storybook documentation has been added to package.json.

Changes

Files	Change Summary
.storybook/index.mdx, .storybook/main.ts	New documentation file added for the UI library. Storybook configuration updated to include @storybook/addon-docs and recognize Markdown files as story entries.
README.md	Restructured content by removing installation and usage instructions, and adding a "Documentation" section with external reference for details.
package.json	Added @storybook/addon-docs dependency (^8.6.11) under devDependencies.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant S as Storybook
    participant D as Docs File (index.mdx)

    U->>S: Request UI Library documentation
    S->>D: Load documentation content
    D-->>S: Return documentation data
    S->>U: Render updated documentation view with addon-docs

Loading

Possibly related PRs

• docs: add index page and move instructions to site #54: The changes in the main PR are directly related to those in the retrieved PR, as both introduce a new documentation file (.storybook/index.mdx), modify the Storybook configuration to include this file, and update the README to direct users to the new documentation.

Poem

Hopping through code with carrot delight,
I found new docs gleaming bright.
Storybook now sings a clearer song,
With addon-docs, nothing's wrong.
A happy rabbit hops in joyous cheer –
A world of docs is now so near!

---

📜 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 4560c1a and 91a68bc.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (4)

• .storybook/index.mdx (1 hunks)
• .storybook/main.ts (2 hunks)
• README.md (1 hunks)
• package.json (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[github-actions]

🎉 This PR is included in version 4.0.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀