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.

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

Documentation #40

Closed
oklas opened this issue Oct 13, 2021 · 3 comments
Closed

Documentation #40

oklas opened this issue Oct 13, 2021 · 3 comments
Labels
discussion 🗨️ Discussion about a particular topic. documentation 📑 Improvements or additions to documentation

Comments

@oklas
Copy link
Contributor

oklas commented Oct 13, 2021

We need to run the documentation. We can use the free js.org domain on this stage, for example, obviously:

node-oauth.js.org

I have experience to set it up it for my open source projects, along with the GitBook documentation engine. Both also used by the well-known Redux (or at least Redux used GitBook before did not check for now). Thereat it was easy, but now I would prefer to use something more interesting. Most likely including but not limited to JSDoc which is mentioned in the discussion #5

@oklas oklas changed the title Docuentation Documentation Oct 13, 2021
@HappyZombies HappyZombies added discussion 🗨️ Discussion about a particular topic. documentation 📑 Improvements or additions to documentation labels Oct 13, 2021
@jankapunkt
Copy link
Member

I could help by setting up JSDoc and make sure we have a good documentation coverage

@HappyZombies
Copy link
Member

HappyZombies commented Oct 13, 2021

This sounds like a great idea, but I really think we have other priorities right now. There's no reason to get these docs up and running ASAP, when we haven't even introduced new and/or breaking changes. For the time being we can link the docs from the original repo.

@HappyZombies HappyZombies added the low priority 🐢 This is not high on our priority list label Oct 13, 2021
@jorenvandeweyer jorenvandeweyer removed the low priority 🐢 This is not high on our priority list label Dec 19, 2021
@HappyZombies
Copy link
Member

Closing in favor of #118

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion 🗨️ Discussion about a particular topic. documentation 📑 Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants