docs: update directory structure in readme

[Mackenzie-OO7]

Overview

This PR updates the directory structure in the README to reflect the new directories.

Summary by CodeRabbit

• Documentation
  • Updated the directory structure in the README for improved clarity.
  • Replaced /developers with /how-to guides and /nodes with /tutorials.
  • Added guides for running a node, deploying rollups, and building on Celestia under the new categories.
  • Marked the comment regarding the /guides category as a work-in-progress (WIP).

[coderabbitai]

Walkthrough

The pull request updates the README.md file, specifically modifying the directory structure of the documentation. The categories /developers and /nodes have been replaced with /how-to guides and /tutorials. The new /how-to guides category includes guides for running a node, deploying rollups, and building on Celestia, while the /tutorials category focuses on tutorials for interacting with the celestia-node. The comment regarding the /guides category remains but is marked as a work-in-progress.

Changes

File	Change Summary
README.md	Updated directory structure: /developers → /how-to guides, /nodes → /tutorials. Retained comment on /guides as WIP.

Possibly related PRs

• docs: Added a link to the project site #1726: The changes in the README.md file to include a link to the Celestia website are related to the overall documentation structure updates in the main PR, which also focuses on enhancing clarity and organization.
• fix navigation to previous page #1729: The modifications in the developers/blobstream-contracts.md file regarding navigation improvements align with the main PR's goal of restructuring documentation for better user experience and clarity.
• Implement diataxis #1742: The implementation of the diataxis framework aims to improve the organization of documentation, which is directly related to the changes made in the main PR to enhance the directory structure and clarity of the documentation content.

Suggested reviewers

• jcstein

🐇 In the garden of guides, we hop and play,
With tutorials blooming, brightening the way.
From nodes to how-tos, the paths are now clear,
Join us in learning, there's nothing to fear!
A warren of wisdom, come take a look,
In our freshly updated, delightful new book! 📚✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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

🧹 Outside diff range and nitpick comments (1)

README.md (1)

38-40: Consider adding example content types for each category.

To help users and contributors better understand what belongs where, consider adding 1-2 specific examples for each category. For instance:

• how-to guides: "How to set up a light node", "How to deploy a sovereign rollup"
• tutorials: "Tutorial: First steps with celestia-node", "Tutorial: Data availability sampling"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 89df5ae and b93b36e.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

README.md (1)

38-40: LGTM! Clear and well-organized directory structure.

The new categorization into "how-to guides" and "tutorials" provides a clearer separation of concerns and makes it easier for users to find relevant documentation.