8000 Docs fixes by andynog · Pull Request #368 · cometbft/cometbft · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

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 28 commits into from
Feb 22, 2023
Merged

Docs fixes #368

merged 28 commits into from
Feb 22, 2023

Conversation

andynog
Copy link
Contributor
@andynog andynog commented Feb 21, 2023

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

  • Tests written/updated
  • Changelog entry added in .changelog (we use unclog to manage our changelog)
  • Updated relevant documentation (docs/ or spec/) and code comments

@andynog andynog self-assigned this Feb 21, 2023
@andynog andynog added the documentation Improvements or additions to documentation label Feb 21, 2023
Copy link
Contributor
@cason cason left a 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.

@alijnmerchant21 alijnmerchant21 self-requested a review February 22, 2023 17:09
@andynog andynog added the backport-to-v0.34.x Tell Mergify to backport the PR to v0.34.x label Feb 22, 2023
@andynog andynog added the backport-to-v0.37.x Tell Mergify to backport the PR to v0.37.x label Feb 22, 2023
@andynog andynog marked this pull request as ready for review February 22, 2023 19:57
@andynog andynog requested review from a team as code owners February 22, 2023 19:57
@andynog andynog mentioned this pull request Feb 22, 2023
8 tasks
@andynog andynog merged commit 28baba3 into main Feb 22, 2023
@andynog andynog deleted the docs-fixes branch February 22, 2023 22:22
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>
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
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

docs: fix broken links
3 participants
0