refactor: docs path updates#17459
Conversation
There was a problem hiding this comment.
added this in here so its uniform with the docs docusaurus.js, should be able to be deleted later
github-actions
Bot
added
C:x/staking
C:CLI
C:x/gov
C:Keys
samricotta
force-pushed
the
sam/change-paths-docs
branch
from
0324bb8 to
c4791bc
Compare
👍🏾 Then can we have a PR disabling the deploy github action? |
lets do it in this pr |
core and basics can be the same thing. or we can do beginner, intermediate and advanced |
julienrbrt
left a comment
julienrbrt
left a comment
There was a problem hiding this comment.
Some links are still broken. I still do not understand the README renaming changes, given that docusaurus know how to display this properly: https://docusaurus.io/docs/next/sidebar/autogenerated#category-index-convention
|
|
||
| ## Add modules page list | ||
| cat ../x/README.md | sed 's/\.\.\/docs\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./docs/modules/README.md | ||
| cat ../x/README.md | sed 's/\.\.\/docs\/build\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./docs/build/modules/"$MODDOC/$(basename "$D").md" |
There was a problem hiding this comment.
This should still be ./docs/modules/README.md instead of this for this line, as mentioned above.
| MODDOC=docs/build/modules/$(basename "$D") | ||
| rm -rf $MODDOC | ||
| mkdir -p $MODDOC && cp -r $D/README.md "$_" | ||
| mkdir -p $MODDOC && cp -r $D/README.md "$MODDOC/$(basename "$D").md" |
There was a problem hiding this comment.
I still do not understand why they cannot stay as README.md.
Docusaurus will render those properly and this avoids the link breakage you have in modules docs.
There was a problem hiding this comment.
Hmm, okay. The reason I added this in was bc it was reading as README.md when i built. But trust you and ill remove those then
|
@julienrbrt suggestions on this last link 
|
There was a problem hiding this comment.
Duplicated - is already in build
There was a problem hiding this comment.
Duplicated - is already in build
This link is fine as it is an example, that is even commented, so it won't render. |
tac0turtle
left a comment
tac0turtle
left a comment
There was a problem hiding this comment.
id say lets merge it then test it on the other repo and see how it works. everything looks good now
|
@Mergifyio backport release/v0.50 |
❌ No backport have been createdDetails
GitHub error: |
|
@Mergifyio backport release/v0.50.x |
✅ Backports have been createdDetails
|
3 participants
Description
Closes: #17458
Closes: #17380
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...
!to the type prefix if API or client breaking changeCHANGELOG.mdmake lintandmake testReviewers 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...
!in the type prefix if API or client breaking change