docs(specs): remove root level state machine modules #3275
Conversation
| @@ -2,7 +2,6 @@ | |||
| authors = ["Celestia Labs"] | |||
| language = "en" | |||
| multilingual = false | |||
| src = "src" | |||
There was a problem hiding this comment.
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
requested review from
cmwaters and
rach-id
and removed request for
a team
WalkthroughWalkthroughThe recent updates involve refining the documentation and configuration for the Celestia App Specifications. Changes include updating the Changes
Assessment against linked issues
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| - [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) |
There was a problem hiding this comment.
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
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`.
Closes #3270 by removing the redundant list of state machine modules on the root level README.md.
Closes #3151 by git ignoring
theme.