-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
[R4R] New docs V1 (merge master-docs to master) #5379
Conversation
Co-Authored-By: Alessio Treglia <quadrispro@ubuntu.com>
Co-Authored-By: Alexander Bezobchuk <alexanderbez@users.noreply.github.com> Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-Authored-By: Alessio Treglia <quadrispro@ubuntu.com> Co-Authored-By: frog power 4000 <rigel.rozanski@gmail.com>
Co-Authored-By: Karoly Albert Szabo <szabo.karoly.a@gmail.com> Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
@@ -1,3 +1,8 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this for? (Note, this renders in markdown).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we use that in the website build. I'll see with @fadeev if we can change convention to
<!--
---
parent:
order: false
---
-->
so that it does not render in markdown
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<!--
won’t work out of the box, because VuePress parses files for ---
(this is hard-coded into VP) and then passes them to gray-matter
JS-lib for further conversion into JSON.
Of course, we can comment frontmatter out and strip <!--
and -->
at build even with something like sed 's/<!--//g'
. That being said, I think we should think about maintainability of all this before we add any more custom things to our markdown files. I’m not saying we shouldn’t (I actually like extending stuff), I just think we should think about it, or we’ll to end up with a hodgepodge of custom syntax parsed with hacky shell-scripts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add a link on the docs/README.md
to the rendered documentation on the website. I think that suffices (at least for me).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great @fedekunze. Will do so as soon as this PR is merged.
We will think of ways to improve readability of github in later upgrades
docs/architecture/README.md
Outdated
@@ -30,5 +36,9 @@ Please add a entry below in your Pull Request for an ADR. | |||
- [ADR 009: Evidence Module](./adr-009-evidence-module.md) | |||
- [ADR 010: Modular AnteHandler](./adr-010-modular-antehandler.md) | |||
- [ADR 011: Generalize Genesis Accounts](./adr-011-generalize-genesis-accounts.md) | |||
<<<<<<< HEAD:docs/architecture/README.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fix merge conflict remnants
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
@@ -1,3 +1,9 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ditto. can we avoid this being rendered in markdown?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please see comments above
Done @fedekunze |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK -- delegating trust to the docs team et al that the contents are correct. Any corrections can be made in subsequent PRs.
Description
This PR brings to
master
all the docs changes that have been worked on in the past months. They are accompanied with a new docs website, the release of which is planned to coincide with the upcoming Hub upgrade.Note that almost all changes included in this PR have already been reviewed in other PRs to the
master-docs
branch. Here is the list (there's prob more):Note:
The new docs build process included in this PR should not break the current docs website. Instead, the new docs should be deployed to
docs.cosmos.network
. Therefore, it'd be great to merge this PR before end of tomorrow (Tuesday) so that we can test if it works properly. We will do a redirect fromcosmos.network/docs
todocs.cosmos.network
after the Hub successfully upgrades.Sidenote:
Companion Gaia PR: cosmos/gaia#183
For contributor use:
docs/
) or specification (x/<module>/spec/
)godoc
comments.Unreleased
section inCHANGELOG.md
Files changed
in the Github PR explorerFor admin use:
WIP
,R4R
,docs
, etc)