OpenSourceBrain / OpenSourceBrain/Documentation
Redo FAQ document
Open
Nobody has claimed this yet.
C: content
T: enhancement
V: OSBv1
V: OSBv2
- Dominant language
- Python
- Stars
- 13
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
The current FAQs seem to be mostly OSBv1 related, although some information is general enough to apply to OSB in general. So we may need to re-organise/re-write the page and move things to other pages.
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 the current FAQ document and separating OSBv1-specific information from content that applies to OSB generally. Identify which material belongs on other documentation pages, then reorganize and rewrite the FAQ. Done means the FAQ has a clearer scope and relevant information has been moved to appropriate pages.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100