You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Dev documentation in the project README has been updated with #83 and #99. The docusaurus should also be updated with this information. The files for this are maintained with version control in finos-vuu/docs. The README and the docusaurus are not currently linked. Maintaining two identical copies of documentation is inefficient and opens the door for both versions to become out of sync with each other. Ideally, the documentation visible in the GitHub README and the docusaurus site will have the same source code. so documentation only needs to be amended once to propagate to both sites.
Work Required
Investigate a way of coalescing the README.md and documentation located in finos-vuu/docs
Outcome
a list of files from finos-vuu/docs/ that we want to include in our finos-vuu/README.md
Approach/es on how to generate a README.md from multiple markdown files
Proof of Concept
Notes
All information in the README should be in the docusaurus. Not all information in the docusaurus needs to be in the README.
layout server and workspace settings docs are only in README at the moment. We need to pull those in docs.
The text was updated successfully, but these errors were encountered:
Background
Dev documentation in the project README has been updated with #83 and #99. The docusaurus should also be updated with this information. The files for this are maintained with version control in
finos-vuu/docs
. The README and the docusaurus are not currently linked. Maintaining two identical copies of documentation is inefficient and opens the door for both versions to become out of sync with each other. Ideally, the documentation visible in the GitHub README and the docusaurus site will have the same source code. so documentation only needs to be amended once to propagate to both sites.Work Required
finos-vuu/docs
Outcome
Notes
The text was updated successfully, but these errors were encountered: