JanusGraph / JanusGraph/janusgraph
Improve meta-property documentation
Open
Nobody has claimed this yet.
area/docs
- Dominant language
- Java
- Stars
- 5.8k
- Forks
- 1.2k
- Avg merge
- 13h 53m
- Merged PRs (30d)
- 6
Description
Section 26.3 of the docs discusses meta-properties but not by name. I think this may be confusing for folks jumping between this and the TinkerPop docs. Perhaps we could update the docs to specifically reference meta-properties and extend the example.
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 Section 26.3 of the documentation and compare its terminology with the referenced TinkerPop documentation. Update the section to explicitly name meta-properties and extend its example; the documentation should clearly explain the concept and align with the related TinkerPop material.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100