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.

Sign up for GitHub

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

Jump to bottom

Recreate the docs #153

Open
dchege711 opened this issue Jun 9, 2024 · 1 comment
Open

Recreate the docs #153

dchege711 opened this issue Jun 9, 2024 · 1 comment
Assignees
@dchege711
Labels
docs

Comments

@dchege711
Copy link
Owner

After #152, JSDoc does not play well anymore. Figure this out.
@dchege711 dchege711 added the docs label Jun 9, 2024
@dchege711 dchege711 self-assigned this Jun 9, 2024
@dchege711
Copy link
Owner Author

TypeDoc 1 might be a good replacement. 2 explores this via:

npm uninstall jsdoc
npm install typedoc --save-dev
rm -rf .docs/
npx typedoc
pushd src/public
npx typedoc

@dchege711 dchege711 changed the title Update the docs Recreate the docs Jun 9, 2024
dchege711 added a commit that referenced this issue Jun 9, 2024
@dchege711
[Docs] Remove stale JSDocs
872dd36 
Stale docs are worse than no docs. #153 tracks adding correct docs.

[1]: #153
@dchege711 dchege711 mentioned this issue Jun 9, 2024
Merged
dchege711 added a commit that referenced this issue Jun 9, 2024
@dchege711
Delete stale docs and fix @types/markdown-it dep error (#154)
add4588 
* [Docs] Remove stale JSDocs

Stale docs are worse than no docs. [1] tracks adding correct docs.

Also run `npm i --save-dev @types/markdown-it` to fix a CI error [2].

[1]: #153
[2]: https://github.com/dchege711/study_buddy/actions/runs/9438438468/job/25995410769?pr=154
dchege711 added a commit that referenced this issue Jun 9, 2024
@dchege711
[ES] Remove unused dependencies (#157)
cd65471 
Uninstall the following unused packages:

* express-validator
* jsdom, @types/jsdom
* showdown, @types/showdown
* babel, babel-loader, and @babel/core
* clean-webpack-plugin
* highlightjs
* mathjax
* nodemon

Remove JSDoc references as JSDoc doesn't work. See #153

[1]: #153
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dchege711 dchege711

Labels
docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dchege711