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
Update package repos for the client-side doc renderer #418
Closed
13 tasks done
jason0x43 opened this issue
Apr 12, 2018
· 3 comments
· Fixed by dojo/streams#20, dojo/stores#171, dojo/shim#138, dojo/routing#137 or dojo/loader#161
Closed
13 tasks done
Update package repos for the client-side doc renderer #418
jason0x43 opened this issue
Apr 12, 2018
· 3 comments
· Fixed by dojo/streams#20, dojo/stores#171, dojo/shim#138, dojo/routing#137 or dojo/loader#161
Milestone
Comments
jason0x43
added a commit
to jason0x43/core
that referenced
this issue
Apr 24, 2018
jason0x43
added a commit
to jason0x43/i18n
that referenced
this issue
Apr 24, 2018
jason0x43
added a commit
to jason0x43/interop
that referenced
this issue
Apr 24, 2018
themes doesn't have a |
This was referenced Apr 24, 2018
This was referenced Apr 24, 2018
some keywords in dojo/streams#20 closed this by accident. Reopening. |
Updated all of the repos. May need some cleanup as we bring the data into dojo.io |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Packages that should be updated:
cliwidget-core (Add API docs widgets#534)widgets (API docs widget-core#909)These updates are to support the doc viewer that is being added to dojo.io for dojo/meta#239 and #350. For testing, a version of the dojo.io code with the viewer is at https://github.com/jason0x43/dojo.io/tree/itorrey-docs-revamp.
If a repo should have api docs (i.e., they're meaningful), generate them using the
intern-dev-api
command from @theintern/dev. (In the long run something should be added to the dojo build tools, but for now this works.) In a given repo,npm install @theintern/dev --no-save
npx intern-dev-api
This will produce a
docs/api.json
file in that contains information about the modules reachable using the package'stsconfig.json
.Each repo should also have the following metadata added to it's README:
Only add the "api" property if the repo contains an api.json. The "pages" properly is only needed if the repo has doc pages other than the README. These pages will be listed under the main doc link in the doc viewer's left sidebar.
If any parts of the README should not be shown in the dojo.io site, they can be masked by surrounding them with start-github-only, end-github-only tags:
The text was updated successfully, but these errors were encountered: