Documentation Revamp - Githubissues

oscafrica / documentation

✍️ All OSCA documentation (WIP)

https://docs.oscafrica.org

MIT License

26 stars 19 forks source link

Documentation Revamp #81

Open BolajiAyodeji opened 1 year ago

BolajiAyodeji commented 1 year ago

This is a placeholder issue to fix all pending documentation issues and write all pending docs. This would take the documentation project to a stable version 1.0.0. I'd add (and update accordingly) the tasks required, guidelines, and expectations for this revamp below soon; thank you.

Explore all subtasks in this GitHub project board (WIP). We'll let us know when tasks are ready for assignments.

Tasks

[x] Review and reorganize the documentation navigation and page structure.
[ ] Update the contributing guidelines (highlighting the Gitbook integration sync).
[ ] Sync with all OSCA teams for the required team-specific documentation.
[ ] Research and outline all documentation pages required (help-needed).
[ ] Create tasks for all sub-issues.
[ ] Call for contributors from the OSCA community.
[ ] Write documentation for pending and new pages.
[ ] Review style guide and templates.
[ ] Docs testing and reviews.
[ ] Setup semantic releases.
[ ] ...

larrymiami commented 1 year ago

@BolajiAyodeji I would like to be part of this, i dont have experience with writing oss documentation but i have been contributing mostly with engineering related issues, if you could point me in the right direction it would gladly help

BolajiAyodeji commented 1 year ago

@BolajiAyodeji I would like to be part of this, i dont have experience with writing oss documentation but i have been contributing mostly with engineering related issues, if you could point me in the right direction it would gladly help

Sure! We'd be happy to have you help. For now, this project has not commenced and I will communicate when all the tasks for sub-issues are defined (as you might see from the checklist) so you can request to be assigned to any of your choosing. For now, ensure to join our Discord server; thank you.

victor-cody commented 1 year ago

Hi @BolajiAyodeji I would like to be part of this when the project has commenced. I have experience contributing to OSS documentation and would be absolutely delighted to do that for a project that imparts the African tech community which I am a part of. 😊

BolajiAyodeji commented 1 year ago

Hi @BolajiAyodeji I would like to be part of this when the project has commenced. I have experience contributing to OSS documentation and would be absolutely delighted to do that for a project that imparts the African tech community which I am a part of. 😊

Sure! We'd be happy to have you help.

prince-dev41 commented 1 month ago

Hello! I am Prince Ekpinse, and I would like to contribute to this issue. Can I take on some of the tasks?