-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add more docs for FE, Link to BE docs #90
Conversation
.github/workflows/ci.yml
Outdated
@@ -28,7 +28,7 @@ jobs: | |||
run: | | |||
python -m pip install --upgrade pip setuptools wheel | |||
pip install -r requirements.txt | |||
npm ci | |||
npm ci --force |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because tsdoc to markdown package is currently not support TS > 5.0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this same error is also thrown when running npm install on the repo atm - i don't think making users always use npm install --force is a good idea (or good practice)
attempting to run npm run docs crashes for me, with the error |
Remove tsdoc2markdown now because it does not support ts>5.0 at the moment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The backend docs issue i think should be fixed in a separate ticket (hence me paging alex).
Please fix the composables issue before merging.
nav: [ | ||
{ | ||
text: 'Backend', | ||
link: '/backend/_build/markdown/', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this links to the index, but links from the index onwards don't seem to work. i tried renaming one of the backend markdown files so the file name doesn't contain any "."s, which fixed the issue - @4lex0017 is it possible for sphinx to have a different separating character rather than "." for module namespacing? (like "backend-modules-api_service.md" rather than "backend.modules.api-service.md")
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nope it is not possible
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unless we wirite a script to do it
Notes: Backend docs is now linked but not reliable
Run
npm run docs
to see result