Improved documentation and install instructions
Open
Nobody has claimed this yet.
documentation
- Dominant language
- JavaScript
- Stars
- 32
- Forks
- 8
- Avg merge
- 13m
- Merged PRs (30d)
- 1
Description
The documentation is currently a bit thin. In order to reach a wider developer audience and attract outside contributors, it would be beneficial to add the following to the readme:
- Project Summary
- Architectural Overview
- Installation Instructions
- Spatialite Primer & Compilation Guide
- Overview of the modules:
- Place
- Geometry
- Shard
- Hierarchy
- Property
- Spatial Relationship
- Point in Polygon
- Running Tests
- RESTful API
- Demo App
Contributor guide
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 README and compare it with the requested sections: project summary, architecture, installation, Spatialite compilation, modules, tests, RESTful API, and demo app. Review the Place, Geometry, Shard, Hierarchy, Property, Spatial Relationship, and Point in Polygon areas before documenting them. Done means the README covers each listed topic with accurate instructions for installation and running tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100