[BN-1487]: Consolidate Docs into Main Portal #31
Merged
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.
Purpose
Currently, we have our repo specific documentation living alongside each of the product repos.
https://topl.github.io/Bifrost/
https://topl.github.io/brambl-cli/
https://topl.github.io/BramblSc
The motivation for this is to encourage code submissions to also include documentation updates.
We run into the issue where this docs portal gets out of date quickly, so this PR introduces the remote content plugin to fetch the markdown from each of these repos and include links to the product repos with more information.
This also includes the branding update for Apparatus.
Approach
.gitignore
since they are pulled on each deployment.Misc changes
direnv
files for reproducible Nix environments.repository_displatch
GitHub action so we can eventually trigger a doc rebuild when docs are updated in the child repos. (not currently implemented, but I can only test this if therepository_dispatch
workflow exists in the main branch).Testing
Built and deployed locally.
Tickets