Skip to content

Documentation Revamp #81

Description

@BolajiAyodeji

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.
  • ...

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions