Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Improve and Maintain OSCA Documentation #86

Open
LuluNwenyi opened this issue Feb 18, 2025 · 2 comments
Open

Docs: Improve and Maintain OSCA Documentation #86

LuluNwenyi opened this issue Feb 18, 2025 · 2 comments

Comments

@LuluNwenyi
Copy link

LuluNwenyi commented Feb 18, 2025

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

  1. Are there any existing documentation guidelines I should follow?
  2. Are there specific high-priority pages that need attention first?
  3. 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! 👀

Copy link

Hey, there! 👋, We welcome all kinds of contributions, please feel free to contribute and/or ask questions.' Someone will attend to your issue soon. ☺️

@Ruth-ikegah
Copy link

Ruth-ikegah commented Feb 18, 2025

Hi @LuluNwenyi thank you for opening an issue to update our documentation! I will share this with them team and get their feedback.

cc: @BolajiAyodeji

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants