bitovi / bitovi/documentjs

Example documentjs.json files.

Open
#160 3 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
JavaScript
Stars
598
Forks
371
PR merge metrics
No merged PRs in 30d

Description

We should try to have only one place in the API docs that shows example `documentjs.json` files. All other pages should basically say things along the lines of

> "make sure your documentjs.json is in place. Refer to [the configuration page](http://documentjs.com/docs/DocumentJS.guides.configuring.html) for examples."

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the API documentation and the linked configuration page at documentjs.com/docs/DocumentJS.guides.configuring.html. Find the pages that currently show example documentjs.json files, consolidate those examples on the configuration page, and replace other examples with references to it. Done means the configuration page is the single example location and other pages point readers there.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.