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

Create better API docs index #26

Open
wwilsman opened this Issue May 1, 2018 · 2 comments

Comments

Projects
None yet
2 participants
@wwilsman
Member

wwilsman commented May 1, 2018

We could use this index as a place to explain the process behind how the docs are generated.

@Robdel12

This comment has been minimized.

Member

Robdel12 commented May 1, 2018

If this is going to be a quest issue it should have enough info for anyone to be able to pick it up and do something with. I know the other ones aren't fully fleshed out yet but that's the goal for them.

@wwilsman

This comment has been minimized.

Member

wwilsman commented May 1, 2018

Things to include on this page would be

  • We use JSDoc to generate a JSON file for a package.
  • We filter out private functions that don't belong to a class, such as utils.
  • Middleman uses this data to generate this portion of the site.
  • Above the explanation, we could also have a short summary about each package and link to it's repo and docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment