Doc improvements
Open
Nobody has claimed this yet.
help wanted
- Dominant language
- HTML
- Stars
- 24
- Forks
- 68
- PR merge metrics
- No merged PRs in 30d
Description
These are the points I noticed during my maintenance that may need improvement.
- How do union work?
https://github.com/SeaQL/sea-query/issues/879 - How are ORM types converted to query types?
https://github.com/SeaQL/sea-query/issues/879 - Mock is difficult to use
https://github.com/SeaQL/sea-orm/issues/2309 - Self references
https://github.com/SeaQL/sea-orm/issues/2923 - LTree
https://github.com/SeaQL/sea-orm/discussions/197 - dense model and relation attributes
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 linked sea-query issues and sea-orm issue and discussion to understand the requested topics. Group the questions about unions, type conversion, mocking, self references, LTree, and model attributes, then identify the relevant website documentation pages. Done means the agreed topics are covered clearly in the documentation.
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
- 25/100