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

Better Docs Site #203

Open
5 of 6 tasks
pzuraq opened this issue Feb 23, 2018 · 4 comments
Open
5 of 6 tasks

Better Docs Site #203

pzuraq opened this issue Feb 23, 2018 · 4 comments

Comments

@pzuraq
Copy link
Contributor

pzuraq commented Feb 23, 2018

The initial work we did to use ESDoc for our documentation was good, but it's not ideal for all of our use cases (like writing guides, describing caveats, etc). I'm currently working with the Ember Learn team on ember-cli-addon-docs to create a unified way to write Ember addon documentation. This issue is to track that progress, and the various use cases we'd like to support once it's completed:

  • Simple modules-based navigation of API docs, emphasis on clarity and ability to quickly find the paths to functions a la ESDoc
  • Ability to tie together multiple addons into a single docs site (now that @ember-decorators has been broken out into many packages)
  • Fully automated deployment
  • Individual Fixes
@yarigpopov
Copy link
Contributor

link for docs site doesn't work
https://ember-decorators.github.io/ember-decorators

feels like gh-page branch doesn't contain proper stuff https://github.com/ember-decorators/ember-decorators/tree/gh-pages

@pzuraq
Copy link
Contributor Author

pzuraq commented May 10, 2018

We're aware of the issue, it's not the gh-pages branch. index.html exists but isn't showing up, which leads me to believe that something in the transition turned of github pages. I don't have ownership permissions on the repo, so I can't check to see what's wrong just yet.

@CodingDive
Copy link

It would also be great to have a fork me on GitHub link/corner to this repository. I couldn't find any link inside the docs and often found myself typing out the GitHub URL to get here.

@buschtoens
Copy link
Collaborator

@ReasonableDeveloper ember-cli-addon-docs luckily supports that already! I think we only need to update and deploy the docs again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants