Cannot generate docs from local

Open
#74 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
build-system, documentation

Research direction

Start by reproducing the local generation flow and comparing current behavior with commit 8a34672cffdd73fd2c1fa40139242f3af993b32d. Inspect the generated output under tmp/json-docs/ember and tmp/json-docs/ember-data, then check how ember-api-docs uses that output when running yarn start:local. Done means a new local version is generated and appears in the dropdown without blocking the related work in #70.

Written by the indexing model from the issue text.

Description

it looks like the updates over the past week have broken the ability for ember-jsonapi-docs to generate local api documentation. Not sure what is going on? Nothing appears for the new version in tmp/json-docs/ember or tmp/json-docs/ember-data

As a result, the generated version does not appear in the dropdown in ember-api-docs when running yarn start:local.

See also #70

Going back to commit 8a34672cffdd73fd2c1fa40139242f3af993b32a fixes that ability, although it hangs on downloading past versions.

This issue is holding up https://github.com/emberjs/data/pull/6449

Dominant language
JavaScript
Stars
10
Forks
11
No merged PRs in 30d

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-jsonapi-docs

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

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.