openframeworks / openframeworks/openFrameworks
attach documentation into release itself
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 10.4k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 9
Description
Hi,
I know It's probably not that much of an issue, but really, for someone who is coming from Processing background, it is very hard to get used to fact that "code is documentation" for most of the time. I realized once I started to teach Processing (even when I'm not active user anymore), that having docs at disposal any time (and not just while beeing online) is very powerful. I am aware of the fact that as far as description goes, Processing is still lightyears ahead, but still... Can you ship OF with 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
Start by reviewing how openFrameworks releases are packaged and where its documentation currently lives. Determine which documentation should ship with each release and how users would access it offline. Done means a release includes usable documentation for offline use.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation, release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100