phalcon / phalcon/documentation
RFC: New repository for code examples in Documentation
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 23
- Forks
- 29
- Avg merge
- 5h 32m
- Merged PRs (30d)
- 5
Description
Most of the documents bring code snippets. Considering that full file examples would take a lot of space in the documents and make them complex, a new repository with running examples per main classes would be a useful complement to them. The documentation could make direct reference to them. The users can clone the repository and run the examples in his/her local environment to have fully running demos of the code cited in the docs.
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
The issue names no files, tests, or entry points; start by reviewing the existing documentation and its code snippets. Done means creating a separate repository with runnable examples for the main classes and adding direct references to those examples from the documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100