Setup Guide should indicate resources need to be moved to the distribution directory.
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the Setup Guide section covering installation and stylesheet creation. Update the instructions to move the demo and its CSS and image resources into the distribution directory, and clarify how the stylesheet and .md files should be arranged between the style and styleguide directories. Done means the guide documents the required manual resource moves and a practical stylesheet location.
Written by the indexing model from the issue text.
Description
When installing DocJS and documenting an stylesheet, it is necessary to move:
- the demo
- the resources needed on the demo (css, img)
Currently in the guide we indicate that it is necessary to move just the demo. Ideally DocJS would take care of it, or a grunt task would need to be set. But until this is not done, we need to include this task as part of the guide.
Something to consider is to update the guide so that the stylesheet created can be easily moved to the styleguide directory with the demo. Currently we indicate to create the stylesheet under the style directory, but this is not practical if the .md files are also hosted in this location.
- Dominant language
- HTML
- Stars
- 73
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from bitovi/documentcss
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
bitovi/documentcss#64 · 1 comment ·
-
developer relations
Difficulty 4/5 3-5 days Newbie friendliness 15/100
bitovi/documentcss#62 ·
-
Wrong FAQ link Open
Difficulty 1/5 Under an hour Newbie friendliness 45/100
bitovi/documentcss#61 ·
-
Setup Theme Logic Open
Difficulty 5/5 Over a week Newbie friendliness 25/100
bitovi/documentcss#60 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 38/100
bitovi/documentcss#59 ·
All issues in bitovi/documentcss
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100