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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 3 commits into from
Apr 15, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cea837e
docs(specs): remove root state machine modules
rootulp Apr 8, 2024
48b95aa
docs(specs): remove redundant src config
rootulp Apr 8, 2024
6b3b818
docs(specs): ignore theme
rootulp Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions specs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
book
theme
1 change: 0 additions & 1 deletion specs/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

title = "Celestia App Specifications"

[output.html]
Expand Down
6 changes: 0 additions & 6 deletions specs/src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,4 @@
- [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)
Comment on lines 16 to 19
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

Loading
Loading