This repository was archived by the owner on Jan 22, 2025. It is now read-only.
[docs] docs migration #34096
Merged
[docs] docs migration #34096
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
* docs: (cli) minor updates to deploy-a-program.md * address review comments * remove unnecessary impl details from the docs about deploy command upgrade flow * clarify program redeploy section --------- Co-authored-by: norwnd <norwnd>
willhickey
previously approved these changes
Dec 11, 2023
willhickey
approved these changes
Dec 11, 2023
ilya-bobyr
added a commit
that referenced
this pull request
Dec 16, 2023
Our sanity CI check is unhappy about it.
These were added in
commit https://github.com/ilya-bobyr/solana/commit/676e80c80a914c6f41a4f5d12f419d35a8047dd8
Author: Nick Frostbutter <75431177+nickfrosty@users.noreply.github.com>
Date: Mon Dec 11 15:17:13 2023 -0500
[docs] docs migration (#34096)
Seems like CI marked the original change as having an issue, but it was
still submitted.
|
@nickfrosty main docs website https://docs.solana.com/ link to this repo here: https://github.com/solana-labs/solana |
|
This PR shifts the general Solana docs to a new location. All detailed in the PR description... |
I'm aware of that, however, the hyperlink in the top menu bar was not changed, and gives the impression that "docs.solona.com" are deployed from https://github.com/solana-labs/solana, but that is not correct anymore. |
crossdev24
pushed a commit
to crossdev24/solana
that referenced
this pull request
Jun 24, 2024
Our sanity CI check is unhappy about it.
These were added in
commit https://github.com/ilya-bobyr/solana/commit/676e80c80a914c6f41a4f5d12f419d35a8047dd8
Author: Nick Frostbutter <75431177+nickfrosty@users.noreply.github.com>
Date: Mon Dec 11 15:17:13 2023 -0500
[docs] docs migration (solana-labs/solana#34096)
Seems like CI marked the original change as having an issue, but it was
still submitted.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Problem
The current monorepo documentation are very heavily tied to a single validator client implementation, not the multi-client world that is rapidly approaching.
Summary of Changes
This monorepo's documentation is being split into two documentation websites:
Since this migration requires separation of content into two repositories, this repo and the solana-foundation/developer-content repo and will affect the commit history and change traceability, I setup the
developer-contentrepo to maximize the visibility of the docs content changes that will reside in that repo.Below is a detailed account of all changes. Including which documentation resources will reside in which repo and screenshots of the navigation structure for each documentation site.
Generally speaking, there were only select list of changes made:
solana.com/docswhich is yet to be launched)Merging of PRs
To not having conflicting results on search engines or breakdown the developer experience of using this documentation, both of these PRs should be merged in their respective repos together and require some minor further coordination.
Common docs
The common docs PR (solana-foundation/developer-content#31) contains all the documents that will be re-homed at the yet to-be-launched on
solana.com/docsurl:::annotation) to use regular markdown block quotes/clusters/rpc-endpoints.mdand/clusters.mddocs were combined into one"Solana-operated"
/wallet-guide- minor update to the text about supporting wallets and where to find some optionsprivate keytosecret keycommitmentlevel details, "RpcResponse Structure", "Parsed Responses", and "Filtercriteria" sections were all moved to the
/doc/rpcroot page since this commitment details arecommon across all HTTP and websocket RPC methods
/docs/http/indexpage to make the flow ofreading it more clear
jsonParsedencoding where theencodingfield wasalready linked just above
json-structuresgetBlockdocumentThe following is a detailed list of the relocation of each document that was taken out of this repo and re-homed to the "common docs" repo:
Note: All
final routeslisted in this table assume the prefix ofsolana.com/docs/intro/dev/intro/walletsValidator client docs
This PR (#34096) contains all the documents that will be remaining within this monorepo and continue to be coupled with the releases of the validator client in this monorepo.
sidebaris now largely a unified auto generated at build time (aside from theproposalsthat have a separate auto generated sidebar)_category_.jsonfiles were created that facilitate the auto generated sidebars. these are effectively just metadata.docs/src/operations/validator-or-rpc-node.md)The following is a detailed list of the relocation of each document within this repo:
Screenshots