458e9a1533
* Codify breaking change guidelines * feedback * Rename title and add expectations section * Update docs/src/apps/backwards-compatibility.md Co-authored-by: Tyera Eulberg <teulberg@gmail.com> * Update docs/src/apps/backwards-compatibility.md Co-authored-by: Tyera Eulberg <teulberg@gmail.com> * Update docs/src/apps/backwards-compatibility.md Co-authored-by: Tyera Eulberg <teulberg@gmail.com> * Update docs/src/apps/backwards-compatibility.md Co-authored-by: Tyera Eulberg <teulberg@gmail.com> * Update docs/src/apps/backwards-compatibility.md Co-authored-by: Tyera Eulberg <teulberg@gmail.com> * Update docs/src/apps/backwards-compatibility.md Co-authored-by: Tyera Eulberg <teulberg@gmail.com> * Update docs/src/apps/backwards-compatibility.md Co-authored-by: Tyera Eulberg <teulberg@gmail.com> * Update backwards-compatibility.md * Update docs/src/apps/backwards-compatibility.md Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com> * Update docs/src/apps/backwards-compatibility.md Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com> * Update docs/src/apps/backwards-compatibility.md Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com> * Apply suggestions from code review Co-authored-by: Tyera Eulberg <teulberg@gmail.com> Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com> * Specify rust crates and add deprecation process * Promise semver for software releases Co-authored-by: Tyera Eulberg <teulberg@gmail.com> Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com>
Docs Readme
Solana's Docs are built using Docusaurus 2 with npm.
Static content delivery is handled using vercel.
Installing Docusaurus
$ npm install
Local Development
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
$ npm run start
Build Locally
This command generates static content into the build directory and can be
served using any static contents hosting service.
$ docs/build.sh
CI Build Flow
The docs are built and published in Travis CI with the docs/build.sh script.
On each PR, the docs are built, but not published.
In each post-commit build, docs are built and published using vercel to their
respective domain depending on the build branch.
- Master branch docs are published to
edge.docs.solana.com - Beta branch docs are published to
beta.docs.solana.com - Latest release tag docs are published to
docs.solana.com