Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BN-1487]: Consolidate Docs into Main Portal #31

Conversation

admiraladmirable
Copy link
Contributor

@admiraladmirable admiraladmirable commented May 29, 2024

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

Misc changes

  • Update Docusaurus to v3.
  • Add direnv files for reproducible Nix environments.
  • Delete outdated API docs (these should live in the repo docs if necessary).
  • Add PR template and codeowners.
  • Add first pass of 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 the repository_dispatch workflow exists in the main branch).

Testing

Built and deployed locally.

Tickets

  • BN-1487

@admiraladmirable admiraladmirable changed the title Bn 1487 consolidate docs from other repos into main portal [BN-1487]: Consolidate Docs into Main Portal May 30, 2024
@admiraladmirable admiraladmirable requested a review from a team May 30, 2024 17:54
@admiraladmirable admiraladmirable marked this pull request as ready for review May 30, 2024 18:29
@admiraladmirable admiraladmirable force-pushed the BN-1487-consolidate-docs-from-other-repos-into-main-portal branch from a3ed68c to 0bb9839 Compare May 30, 2024 18:51
@admiraladmirable admiraladmirable merged commit 53a920a into main Jun 4, 2024
1 check passed
@admiraladmirable admiraladmirable deleted the BN-1487-consolidate-docs-from-other-repos-into-main-portal branch June 4, 2024 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant