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

[Feature]: Add better JavaScript-specific documentation #13

Open
thinkjrs opened this issue Aug 8, 2021 · 1 comment
Open

[Feature]: Add better JavaScript-specific documentation #13

thinkjrs opened this issue Aug 8, 2021 · 1 comment
Assignees
@thinkjrs

Comments

@thinkjrs
Copy link
Member

thinkjrs commented Aug 8, 2021

We're going to use the README documentation as part of the jsdocs output, in addition to the jsdoc inline comment output.

The main readme is also comprised of each languages' particular readme and therefore this could use quite a bit of cleanup before a bigger release is ready.

This should be specific to the JavaScript installation, usage, and example via our Next.js (React) example client/server app.
@thinkjrs thinkjrs mentioned this issue Aug 8, 2021
Open
@thinkjrs thinkjrs changed the title Add better JavaScript-specific documentation [Feature]: Add better JavaScript-specific documentation Aug 8, 2021
@thinkjrs thinkjrs self-assigned this Aug 8, 2021
@thinkjrs thinkjrs mentioned this issue Aug 8, 2021
Merged
@thinkjrs
Copy link
Member Author

To set this up I ever so slightly cleaned up and refactored the tiny example Next.js app.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thinkjrs thinkjrs

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@thinkjrs