Docs update #228
Docs update #228
Conversation
| @@ -12,7 +12,7 @@ To make adjustments to the way the application runs, edit and review [docker-com | |||
|
|
|||
| The UI and API containers have been set to run on start up to install / update dependencies. | |||
|
|
|||
| Set up the [front-end ui client](ui/README.md) or [back-end api server](api/README.md) as needed. | |||
| Set up the [front-end ui client](/ui/) or [back-end api server](/api/) as needed. | |||
There was a problem hiding this comment.
Why was the README.md removed?
There was a problem hiding this comment.
All md files should now be under docs to be picked up by vitepress and displayed in our public facing docs site
There was a problem hiding this comment.
I was simply suggesting that the .md files should still be referenced in the diff above. Should the diff have /docs/ui/index.md instead of /ui/?
| @@ -91,7 +91,7 @@ To meet the requirements outlined above, a distributed architecture is employed. | |||
|
|
|||
| ### 6. Downloading a Dataset File | |||
|
|
|||
| <img src="assets/secure-download-arch-diagram.png" > | |||
| <img src="/secure-download-arch-diagram.png" > | |||
There was a problem hiding this comment.
Not sure if this is an oversight but it appears that the original path had a leading /.
There was a problem hiding this comment.
I believe vitepress needed a relative path for its static asset resolution
|
I reviewed the PR and after our discussion above, the diff makes sense. Could you add docs somewhere (either within the repo or on the wiki) for what would need to be done to update our website (https://sca.iu.edu) when an artifact (markdown files, HTML files, diagrams, etc.) is changed within this repo? Oh, and please also document the name of the Python library that is being used for diagram generation :) |
Description
Updated docs to be used in vitepress and centralized docs into doc folder
Related Issue(s)
Changes Made
Moved many of the docs into docs folder