reference docs migration #1702
Merged
reference docs migration #1702
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
Deploying avalanche-docs with
|
| Latest commit: |
41ae805
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://19cd61e7.avalanche-docs.pages.dev |
| Branch Preview URL: | https://meag-reference-docs-migratio.avalanche-docs.pages.dev |
meaghanfitzgerald
changed the title
meaghanfitzgerald
requested review from
laviniat1996,
dubrado,
martineckardt,
Andyvargtz,
ashucoder9 and
usmaneth
as code owners
meaghanfitzgerald
added
the
DO NOT MERGE
|
blocked by ava-labs/avalanchego#2845 |
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.
Why this should be merged
puts api docs (like this one) directly in https://github.com/ava-labs/avalanchego
How this works
I removed all the AvalancheGo API docs from this repository and moved the content to each API's file in https://github.com/ava-labs/avalanchego. A docusaurus plugin I've implemented in the past is fetching the raw contents and importing them to our site during the build. Details on how I implemented this can be found here.
For example, the metrics-api.md was moved from
https://github.com/ava-labs/avalanche-docs/blob/master/docs/reference/avalanchego/metrics-api.md
to
https://github.com/ava-labs/avalanchego/blob/meag/docs-format/api/metrics/service.md.
Note: once @StephenButtolph merges my changes, this second link will become https://github.com/ava-labs/avalanchego/blob/master/indexer/service.md .
How these changes were tested
yarn build