Docs: Improve and Maintain OSCA Documentation #86
Description
Many of OSCA’s documentation pages are currently empty or lack clear details. As an open-source community, having well-structured and informative documentation is important for onboarding new contributors, explaining community guidelines, and providing clarity on OSCA’s processes.
As a technical writer, I’d love to contribute by filling in these gaps, improving the structure, and ensuring the documentation remains up to date. If possible, I’d also be interested in maintaining the documentation long-term.
Proposed contribution
- Identify missing or incomplete documentation pages.
- Research and draft well-structured content for these pages.
- Improve readability, clarity, and consistency across the documentation.
- Ensure formatting and structure align with best practices for OSCA's documentation style.
- (If possible) Propose a process for ongoing maintenance and updates.
Questions for the maintainers
- Are there any existing documentation guidelines I should follow?
- Are there specific high-priority pages that need attention first?
- Would you be open to a structured maintenance approach (e.g., periodic updates, reviews, etc.)?
Next steps
If this contribution is welcome, I can start by reviewing the current documentation, creating an outline, and submitting a PR with the first set of improvements.
Looking forward to your thoughts! 👀