smarty-php / smarty-php/smarty
Improve Smarty 5 documentation
Open
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 2.3k
- Forks
- 709
- PR merge metrics
- No merged PRs in 30d
Description
Smarty 5 documentation still contains references to pages such as https://smarty-php.github.io/smarty/5.x/programmers/api-functions/api-config-load/ and one can find these in the search index too.
- Search for references to
programmers/in the documentation and rewrite these parts. - Then delete the entire
programmers/after checking to see if everything is covered in the other docs
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
Search the documentation for references to programmers/, including the listed Smarty 5 API page, and inspect where those references appear in the search index. Confirm that the material is covered elsewhere before deleting the entire programmers/ section; done means the references are rewritten, coverage is verified, and the obsolete section is removed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100