-
Notifications
You must be signed in to change notification settings - Fork 636
Docs fixes #368
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
Merged
Merged
Docs fixes #368
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cason
reviewed
Feb 22, 2023
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.
Thanks for this effort.
I've left a couple of comments on the tutorials. We have to come up with a way they are generic, and do not apply to a single version. This is a little more complex since ABCI is under changes from v0.37.
cason
reviewed
Feb 22, 2023
thanethomson
approved these changes
Feb 22, 2023
mergify bot
pushed a commit
that referenced
this pull request
Feb 22, 2023
* fixing broken link quick-start (#319) * fix link to point to relative page (#319) * fix link to point to rpc page (#319) * fix link that works for rpc (#319) * adding front matter to trigger hooks (#319) * add frontmatter to adr page (#319) * make link to configuration page relative (#319) * remove irrelevant text (#319) * updating relative link and removing irrelevant text (#319) * remove front matter from ADR (#319) * fixing broken links unders docs/tools (#319) * fixing broken links under spec/core (#319) * fixing broken links in spec/abci home (#319) * fix uparrows rendering and broken links (#319) * fixing links, comments on abci methods (#319) * fixing links in tutorials (#319) * adding a landing page for Apps (#319) * renaming qa v0.34 page to show in navigation (#319) * rename title of page for navigation (#319) * fixing links on abci client server (#319) * changes to allow RPC top level navigation on docs site (#319) * fixing some more broken references (#319) * reverting link change as per review (#319) * reverting link change as per review (#319) * reverting link in app-dev as per review (#319) (cherry picked from commit 28baba3) # Conflicts: # docs/core/rpc.md # docs/tools/debugging.md # docs/tutorials/go-built-in.md # docs/tutorials/go.md
mergify bot
pushed a commit
that referenced
this pull request
Feb 22, 2023
* fixing broken link quick-start (#319) * fix link to point to relative page (#319) * fix link to point to rpc page (#319) * fix link that works for rpc (#319) * adding front matter to trigger hooks (#319) * add frontmatter to adr page (#319) * make link to configuration page relative (#319) * remove irrelevant text (#319) * updating relative link and removing irrelevant text (#319) * remove front matter from ADR (#319) * fixing broken links unders docs/tools (#319) * fixing broken links under spec/core (#319) * fixing broken links in spec/abci home (#319) * fix uparrows rendering and broken links (#319) * fixing links, comments on abci methods (#319) * fixing links in tutorials (#319) * adding a landing page for Apps (#319) * renaming qa v0.34 page to show in navigation (#319) * rename title of page for navigation (#319) * fixing links on abci client server (#319) * changes to allow RPC top level navigation on docs site (#319) * fixing some more broken references (#319) * reverting link change as per review (#319) * reverting link change as per review (#319) * reverting link in app-dev as per review (#319) (cherry picked from commit 28baba3) # Conflicts: # docs/core/rpc.md # docs/tools/debugging.md # docs/tutorials/go-built-in.md # docs/tutorials/go.md # spec/abci/README.md # spec/abci/abci++_basic_concepts.md # spec/abci/abci++_client_server.md # spec/abci/abci++_methods.md
This was referenced Feb 22, 2023
andynog
added a commit
that referenced
this pull request
Feb 23, 2023
* Docs fixes (#368) * fixing broken link quick-start (#319) * fix link to point to relative page (#319) * fix link to point to rpc page (#319) * fix link that works for rpc (#319) * adding front matter to trigger hooks (#319) * add frontmatter to adr page (#319) * make link to configuration page relative (#319) * remove irrelevant text (#319) * updating relative link and removing irrelevant text (#319) * remove front matter from ADR (#319) * fixing broken links unders docs/tools (#319) * fixing broken links under spec/core (#319) * fixing broken links in spec/abci home (#319) * fix uparrows rendering and broken links (#319) * fixing links, comments on abci methods (#319) * fixing links in tutorials (#319) * adding a landing page for Apps (#319) * renaming qa v0.34 page to show in navigation (#319) * rename title of page for navigation (#319) * fixing links on abci client server (#319) * changes to allow RPC top level navigation on docs site (#319) * fixing some more broken references (#319) * reverting link change as per review (#319) * reverting link change as per review (#319) * reverting link in app-dev as per review (#319) (cherry picked from commit 28baba3) # Conflicts: # docs/core/rpc.md # docs/tools/debugging.md # docs/tutorials/go-built-in.md # docs/tutorials/go.md # spec/abci/README.md # spec/abci/abci++_basic_concepts.md # spec/abci/abci++_client_server.md # spec/abci/abci++_methods.md * fix conflicts * fixing rpc content (#373) * Update docs/core/rpc.md Co-authored-by: Daniel <daniel.cason@informal.systems> * remove the inspect cmd info (#373) * remove RPC section tied to inspect cmd (#373) * fix rpc link (#373) --------- Co-authored-by: Andy Nogueira <me@andynogueira.dev> Co-authored-by: Adi Seredinschi <a@seredinschi.net> Co-authored-by: Daniel <daniel.cason@informal.systems>
andynog
added a commit
that referenced
this pull request
Feb 24, 2023
* Docs fixes (#368) * fixing broken link quick-start (#319) * fix link to point to relative page (#319) * fix link to point to rpc page (#319) * fix link that works for rpc (#319) * adding front matter to trigger hooks (#319) * add frontmatter to adr page (#319) * make link to configuration page relative (#319) * remove irrelevant text (#319) * updating relative link and removing irrelevant text (#319) * remove front matter from ADR (#319) * fixing broken links unders docs/tools (#319) * fixing broken links under spec/core (#319) * fixing broken links in spec/abci home (#319) * fix uparrows rendering and broken links (#319) * fixing links, comments on abci methods (#319) * fixing links in tutorials (#319) * adding a landing page for Apps (#319) * renaming qa v0.34 page to show in navigation (#319) * rename title of page for navigation (#319) * fixing links on abci client server (#319) * changes to allow RPC top level navigation on docs site (#319) * fixing some more broken references (#319) * reverting link change as per review (#319) * reverting link change as per review (#319) * reverting link in app-dev as per review (#319) (cherry picked from commit 28baba3) # Conflicts: # docs/core/rpc.md # docs/tools/debugging.md # docs/tutorials/go-built-in.md # docs/tutorials/go.md * Fixed conflicts * Update docs/tools/debugging.md * change the rpc link (#372) * change another rpc link (#372) * remove the inspect command information (#372) * change one more rpc link (#372) * update link to point to the release instead of main (#372) * change quotes (#372) --------- Co-authored-by: Andy Nogueira <me@andynogueira.dev> Co-authored-by: Adi Seredinschi <a@seredinschi.net> Co-authored-by: Adi Seredinschi <adizere@gmail.com>
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
backport-to-v0.34.x
Tell Mergify to backport the PR to v0.34.x
backport-to-v0.37.x
Tell Mergify to backport the PR to v0.37.x
documentation
Improvements or additions to documentation
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes: #319
This fixes many broken links, typos, references, landing pages, navigation links.
This PR will be used to make the docs.cometbft.com to be ready for production deployment
PR checklist
.changelog
(we use unclog to manage our changelog)docs/
orspec/
) and code comments