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

Documentation Revamp #81

Open
1 of 11 tasks
BolajiAyodeji opened this issue Jan 18, 2023 · 5 comments
Open
1 of 11 tasks

Documentation Revamp #81

BolajiAyodeji opened this issue Jan 18, 2023 · 5 comments
Assignees
Labels
docs-revamp enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@BolajiAyodeji
Copy link
Member

BolajiAyodeji commented Jan 18, 2023

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

  • 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.
  • ...
@BolajiAyodeji BolajiAyodeji added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jan 18, 2023
@BolajiAyodeji BolajiAyodeji self-assigned this Jan 18, 2023
@larrymiami
Copy link

@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
Copy link
Member Author

@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
Copy link

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
Copy link
Member Author

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-revamp enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants