Add comprehensive developer docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 310
- Forks
- 70
- Avg merge
- 2h 9m
- Merged PRs (30d)
- 4
Description
I think the codebase is not really suitable for reading and editing as it is now, as a minimum I would want a table and/or docstrings for mapping CSS features to GenericTranslator methods and back and a doc about the logic flow between the CSS selector input and the XPath result. It would also be nice to have (if possible and not too unwieldy) a table(s) listing all features of CSS3/4 and marking which are supported, not implemented or can't be implemented, and some kind of table of a manually written examples covering all features we support (like the tests but more comprehensive, and hopefully synced with them).
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 by reading GenericTranslator and the existing tests to map CSS features to translator methods and understand the flow from selector input to XPath output. Done means developer documentation covers these mappings and the logic flow, plus support-status tables and manually written examples that stay aligned with the tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100