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

fix(docs): fix script for docs #18443

Closed
wants to merge 1 commit into from
Closed

fix(docs): fix script for docs #18443

wants to merge 1 commit into from

Conversation

samricotta
Copy link
Contributor

@samricotta samricotta commented Nov 10, 2023

Currently the script isnt working and is showing up with errors when run. This might be causing issues here #18436 and https://github.com/cosmos/cosmos-sdk-docs/actions/runs/6818872322/job/18545260045.

This may not resolve the issue on the docs repo but still needs to be fixed.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • Documentation
    • Reorganized the structure of the documentation for better navigation.
    • Added a new document on Rosetta implementation.

@samricotta samricotta added the T:Docs Changes and features related to documentation. label Nov 10, 2023
Copy link
Contributor

coderabbitai bot commented Nov 10, 2023

Walkthrough

Walkthrough

The changes primarily focus on reorganizing the documentation structure in the project. This includes updating file paths, adding a new documentation file (04-rosetta.md), and relocating existing directories (architecture, spec, rfc). The modifications ensure that the documentation files are copied to their new respective locations.

Changes

File(s) Change Summary
04-rosetta.md A new documentation file has been added.
architecture, spec, rfc These existing directories have been relocated.
docs/pre.sh File paths for copying and creating documentation have been updated. This includes paths for the new file and relocated directories.

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

@github-prbot github-prbot requested a review from a team November 10, 2023 14:08
@samricotta samricotta changed the title fix: Fix script for docs fix(docs): fix script for docs Nov 10, 2023
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 79c6418 and 6e361d6.
Files selected for processing (1)
  • docs/pre.sh (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/pre.sh

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Could you explain the rationale? Where does that docs/docs comes from?
Main on the SDK only has one docs folder (contrary to v0.50 and v0.47), as well as the docs repo: https://github.com/cosmos/cosmos-sdk-docs/tree/main/docs

if [ -d "${D}" ]; then
MODDOC=build/modules/$(echo $D | awk -F/ '{print $NF}')
MODDOC=docs/docs/build/modules/$(echo $D | awk -F/ '{print $NF}')
Copy link
Member

Choose a reason for hiding this comment

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

why is this an issue? docs/docs doesnt exist anymore

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Apologies, this should just be for 0.50 and 0.47

@samricotta samricotta closed this Nov 10, 2023
@tac0turtle tac0turtle deleted the sam/fix-pre-script branch September 17, 2024 07:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants