Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(specs): remove root level state machine modules #3275

Merged
merged 3 commits into from
Apr 15, 2024

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Apr 8, 2024

Closes #3270 by removing the redundant list of state machine modules on the root level README.md.
Closes #3151 by git ignoring theme.

@rootulp rootulp self-assigned this Apr 8, 2024
@@ -2,7 +2,6 @@
authors = ["Celestia Labs"]
language = "en"
multilingual = false
src = "src"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This config wasn't doing anything because "src" is the default

src: By default, the source directory is found in the directory named src directly under the root folder. But this is configurable with the src key in the configuration file.

Ref: https://rust-lang.github.io/mdBook/format/configuration/general.html#general-metadata

@rootulp rootulp marked this pull request as ready for review April 8, 2024 20:05
@rootulp rootulp requested review from liamsi and a team as code owners April 8, 2024 20:05
@rootulp rootulp requested review from cmwaters and rach-id and removed request for a team April 8, 2024 20:05
Copy link
Contributor

coderabbitai bot commented Apr 8, 2024

Walkthrough

Walkthrough

The recent updates involve refining the documentation and configuration for the Celestia App Specifications. Changes include updating the .gitignore file to exclude the theme directory, modifying the book.toml file by removing the src field, and enhancing the README.md by removing specific GitHub links. These adjustments aim to streamline the documentation and reduce redundancy, particularly in listing state machine modules across different sections of the app's documentation.

Changes

File Path Change Summary
specs/.gitignore Added theme directory to ignore list
specs/book.toml Removed src field, adjusted file structure
specs/src/README.md Removed specific GitHub links under State Machine Modules

Assessment against linked issues

Objective Addressed Explanation
specs: add minfee module to home page (#3270) The changes do not include updates to the homepage to list the minfee module.
Figure out a way to not maintain two separate lists of state machine modules (#3270) Without specific changes to how modules are listed, it's unclear if this objective has been met. The removal of GitHub links may reduce redundancy but does not directly address the issue of maintaining two separate lists.
Ignore mdbook theme/ (#3151)

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

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. 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 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Comment on lines 16 to 19
- [Resource Pricing](./specs/resource_pricing.md)
- [Multisig](./specs/multisig.md)
- [State Machine Modules](./specs/state_machine_modules.md)
- [blob](https://github.com/celestiaorg/celestia-app/blob/main/x/blob/README.md)
- [blobstream](https://github.com/celestiaorg/celestia-app/blob/main/x/blobstream/README.md)
- [mint](https://github.com/celestiaorg/celestia-app/blob/main/x/mint/README.md)
- [paramfilter](https://github.com/celestiaorg/celestia-app/blob/main/x/paramfilter/README.md)
- [upgrade](https://github.com/celestiaorg/celestia-app/blob/main/x/upgrade/README.md)
- [tokenfilter](https://github.com/celestiaorg/celestia-app/blob/main/x/tokenfilter/README.md)
- [Mainnet Parameters](./specs/params.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip

Codebase Verification

The verification process revealed that all the links listed in the README.md file under the specs/src directory are pointing to files that do not exist in the specified locations. This indicates a significant issue with the documentation as it stands, as none of the provided links are functional, leading to a complete breakdown in navigability and usefulness of the documentation.

Analysis chain

📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-19]

The changes made to the README.md file, specifically the removal of redundant links under the State Machine Modules section, align with the PR's objectives to streamline documentation. Ensure all remaining links are correctly formatted and functional.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify the correctness and functionality of the remaining links in README.md
for link in $(grep -oP '\(./specs/\K[^)]+' specs/src/README.md); do
  if [ ! -f "specs/src/$link" ]; then
    echo "Missing file for link: $link"
  fi
done

Length of output: 3407

@rootulp rootulp enabled auto-merge (squash) April 8, 2024 20:40
Copy link
Member

@ninabarbakadze ninabarbakadze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

much better, thanks

@rootulp rootulp merged commit a6991b6 into celestiaorg:main Apr 15, 2024
35 checks passed
@rootulp rootulp deleted the rp/specs-toc branch April 15, 2024 14:59
ninabarbakadze pushed a commit to ninabarbakadze/celestia-app that referenced this pull request Apr 17, 2024
Closes celestiaorg#3270 by
removing the redundant list of state machine modules on the root level
README.md.
Closes celestiaorg#3151 by git
ignoring `theme`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

specs: add minfee module to home page Ignore mdbook theme/
3 participants