Normalizing structure for intro section of various books
Nobody has claimed this yet.
- Dominant language
- XML
- Stars
- 596
- Forks
- 890
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 55
Description
In the filesystem book the intro duplicates info available in the setup.xml file.
It also seems that we are pretty inconsistent about the structure of various books in what is included or not (e.g. some extensions that don't have resources don't mention them at all, which is a direction which makes sense to take as we are getting rid of them).
Originally posted by @Girgias in https://github.com/php/doc-en/pull/2726#discussion_r1341977714
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 comparing the filesystem book's intro with setup.xml, then inspect the introductory sections of other books and extensions for differences in structure and resource coverage. Document the consistent structure to apply and verify that duplicated setup information is removed while intentional omissions remain consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- xml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100