Skip to content
This repository has been archived by the owner on Jan 16, 2022. It is now read-only.

[Enhancement] Move to a static documentation and a static readme #19

Open
luciferreeves opened this issue Jan 10, 2022 · 0 comments
Open

[Enhancement] Move to a static documentation and a static readme #19

luciferreeves opened this issue Jan 10, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed refactor
Milestone
v6.6.8

Comments

@luciferreeves
Copy link
Owner

Right now, we are generating documentation and readme dynamically using the scripts:

  • npm run readme
  • npm run jsdoc

Now that we have a domain of our own, we should create a static documentation in the docs folder and serve from there. Also the readme should be concise and static. It does not need to contain names of all the functions. Those APIs can be moved to documentation.
@luciferreeves luciferreeves added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed refactor labels Jan 10, 2022
@luciferreeves luciferreeves added this to the v6.6.8 milestone Jan 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed refactor
Projects
None yet
Milestone
v6.6.8
Development

No branches or pull requests
1 participant
@luciferreeves