[Docs] Introduce Docusaurus documentation #252
Merged
Conversation
This file contains 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
…review (and before quickstart + contribution docs are complete)
Olshansk
had a problem deploying
to
github-pages
GitHub Actions
Failure
…r config updates elsewhere).
Olshansk
had a problem deploying
to
github-pages
GitHub Actions
Failure
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Olshansk
had a problem deploying
to
github-pages
GitHub Actions
Failure
Olshansk
had a problem deploying
to
github-pages
GitHub Actions
Failure
Olshansk
force-pushed
the
docs/hello_poktroll
branch
from
eff643d to
3e7e35a
Compare
okdas
approved these changes
Dec 19, 2023
Olshansk
changed the title
|
@h5law I added an @okdas I tended to the techdebt I added and updated a couple minor things. I think we should merge this as is (good enough) to act as a starting point and will update based on feedback we get from our first users. |
10 tasks
bryanchriswhite
added a commit
that referenced
this pull request
Dec 22, 2023
…im-proof * pokt/main: Fix bug introduced by #252 where genesis file was no longer being copied to the right location [Docs] Introduce Docusaurus documentation (#252) [Cleanup] Centralzie websocket url -> endpoint changes (#272) refactor: `NewMinedRelay` to shared testutil (#262) fix: PR template typo 2 (#269) [Testing] Unit tests, E2E tests, logging and other Fixes / "Touchups" (#253) [SDK] feat: Have distinct JSON-RPC and gRPC urls (#261)
bryanchriswhite
added a commit
that referenced
this pull request
Dec 22, 2023
…or/supplier-keys * issues/141/refactor/claim-proof: chore: review feedback improvements chore: review feedback improvements Fix bug introduced by #252 where genesis file was no longer being copied to the right location [Docs] Introduce Docusaurus documentation (#252) [Cleanup] Centralzie websocket url -> endpoint changes (#272) refactor: `NewMinedRelay` to shared testutil (#262) fix: PR template typo 2 (#269) [Testing] Unit tests, E2E tests, logging and other Fixes / "Touchups" (#253) [SDK] feat: Have distinct JSON-RPC and gRPC urls (#261)
bryanchriswhite
added a commit
that referenced
this pull request
Dec 22, 2023
…ctor/supplier-errors * issues/141/refactor/supplier-keys: chore: review feedback improvements chore: review feedback improvements Fix bug introduced by #252 where genesis file was no longer being copied to the right location [Docs] Introduce Docusaurus documentation (#252) [Cleanup] Centralzie websocket url -> endpoint changes (#272) refactor: `NewMinedRelay` to shared testutil (#262) fix: PR template typo 2 (#269) [Testing] Unit tests, E2E tests, logging and other Fixes / "Touchups" (#253) [SDK] feat: Have distinct JSON-RPC and gRPC urls (#261)
okdas
added a commit
that referenced
this pull request
Nov 14, 2024
Introduce the first iteration of dev.poktroll.com using docusarus while also adding a quickstart guide. Done in this PR: - [x] Introduce Docusaurus.io documentation using the `.md` files in this repo - [x] Add a basic quickstart guide - [x] Add a basic contribution guide - [x] Move over existing documents - [x] Add a few admonitions with warning signs & tips - [x] GitHub action to automatically deploy it on merges to main Not done in this PR: - Align the architecture docs with the most up to date architecture - Review all existing (moved over) docs from start to finish Video reference: https://github.com/pokt-network/poktroll/assets/1892194/801a1859-4060-434e-b03e- --------- Co-authored-by: DK <[email protected]> Co-authored-by: h5law <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Introduce the first iteration of dev.poktroll.com using docusarus while also adding a quickstart guide.
Screen.Recording.2023-12-10.at.5.20.05.PM.mov
Changes
Introduce Docusaurus.io documentation using the
.mdfiles in this repo. Also:Did not do in this PR:
Issue
Type of change
Select one or more:
Testing