Add Ember CLI Api docs

Open
#667 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
aws, javascript
Domain
cloud, documentation

Research direction

Start by investigating how https://ember-cli.com/api/ is generated and how api-store.emberjs.com receives documentation, including any release-time job or script in this repository. Done means Ember CLI API documentation is published to the AWS-backed store and available through the API docs viewer.

Written by the indexing model from the issue text.

Description

Didn't see anything filed already for this, so kicking this off.

I looked into how this repo works to see if I could port over https://ember-cli.com/api/, but looks like it's making a request to api-store.emberjs.com, which points to AWS. I'm assuming some script/job is building and posting docs at release time to AWS, and the same needs to happen for Ember CLI. Will post more of my findings here as I discover how it works. If there's any existing work for this, let me know!

Dominant language
JavaScript
Stars
75
Forks
111
Avg merge
45m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ember-learn/ember-api-docs

All issues in ember-learn/ember-api-docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.