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

Update API docs to simplify table of contents #594

Merged
merged 1 commit into from
Mar 14, 2019

Conversation

ygongdev
Copy link
Contributor

@ygongdev ygongdev commented Mar 10, 2019

- [x] Moved setupOnerror to Test Framework APIs section
- [x] Removed Parameters from Table of Content

Additionally,
- [x] Removed Examples from Table of Content
- [x] Moved resetOnerror to Test Framework APIs section
- [x] Adjust number indexing for anchoring purposes to keep variables sorted.

Fixes #542
EDIT: The actual solution should be modifying the documentation build itself.

@ygongdev
Copy link
Contributor Author

O just realized that we need to modify the documentation build, not the API.md

@ygongdev
Copy link
Contributor Author

Currently, the documentation module doesn't support modifying the Table of Content's depth.
However, it seems like a quick trivial change. I created a small PR on documentation to try to get this going, documentationjs/documentation#1215.

@rwjblue
Copy link
Member

rwjblue commented Mar 11, 2019

Sounds great! Thanks for working on this!

@ygongdev
Copy link
Contributor Author

@rwjblue documentation just merged my PR and released a new version.
Let me know if the API.md looks like what we want.

@rwjblue
Copy link
Member

rwjblue commented Mar 13, 2019

This looks great! Thank you for working on this!

There is a conflict in yarn.lock, if you could rebase and correct it I'll happily merge...

@ygongdev
Copy link
Contributor Author

Rebased.

@rwjblue rwjblue merged commit ef762ec into emberjs:master Mar 14, 2019
@rwjblue rwjblue changed the title Update API.md Update API docs to simplify table of contents May 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Issues
2 participants