NUKnightLab / NUKnightLab/juxtapose
better development documentation / missing env.sh.example
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 882
- Forks
- 127
- Avg merge
- 1m
- Merged PRs (30d)
- 2
Description
Developer docs should provide some more direction around getting a local dev environment up and running. Likely an env.sh.example file is also needed
Note, it is possible simple to run a SimpleHTTPServer in the repository root in order to open the examples in the examples folder - this utilizes the current build. However, more clarification is needed on how to get a full development environment running in order to fab serve the website. This should include info about running from the current local build as the CDN for development purposes, or choosing to use the current deployment as the CDN if the development focus is on the site and not on the library
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.
Research direction
Start with the developer documentation and the proposed env.sh.example, then inspect the existing fab serve workflow and the examples folder. Document how to run a local development environment, explain using the current local build or deployment as the CDN, and describe the SimpleHTTPServer option. Done means a newcomer can choose a setup and follow it successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100