Documentation tasks
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 642
- Forks
- 70
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 21
Description
The following elements are currently missing from read the docs and need to be added in:
Ingestion
- node_types
- node_types via df loaders
- parquet loading
- CacheGraph functionality
- Importing nodes from other graphs
GraphViews
- Different types of subgraphs with node_type
- The inverse functions
- property filters
Algorithms/queries
- Nodestate
Graph deletions
- What is the PersistantGraph
Graphql server
- Everything
Vectorisation
- Everything
Indexing
- Everything
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 by reviewing the Read the Docs content for the unchecked topics under Ingestion, GraphViews, Vectorisation, and Indexing. Done means each listed missing element has corresponding documentation and the checklist can be updated; the issue does not name specific files or tests.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100