jaredly / jaredly/redoc

Interactive code snippets not being generated

Open
#13 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
114
Forks
11
PR merge metrics
No merged PRs in 30d

Description

* docre version: `master 73fb3c0 workin on the sidebar`
* Source Docs: https://github.com/scull7/bs-result
* Generated docs here: https://scull7.github.io/bs-result/api/Result.html

Copious amounts of debug output:
[bs-result-docre-debug-output.txt](https://github.com/jaredly/docre/files/2045947/bs-result-docre-debug-output.txt)

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reviewing the linked debug output and the source documentation in scull7/bs-result, then compare it with the generated Result.html page. Determine where interactive code snippet generation stops and verify that the generated documentation contains the expected interactive snippets without the reported debug output.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.