Skip to content

Documentation Migration: io-ts-http to Docusaurus website #1031

@youngjungithub

Description

@youngjungithub

Documentation Migration: io-ts-http to Docusaurus

Background

The current API TS documentation is spread across three sources:

  • GitHub ReadMe files
  • Documentation under each package (such as io-ts-http)
  • Docusaurus website (api-ts/website)

This fragmentation creates redundancy and makes it difficult for users to find the information they need.

Objective

Centralize comprehensive documentation in Docusaurus following the Diátaxis framework, while minimizing README content to essentials.

Scope

Migration of the following files from io-ts-http package:

  1. api-ts/packages/io-ts-http/README.md
  2. api-ts/packages/io-ts-http/docs/apiReference.md
  3. api-ts/packages/io-ts-http/docs/apiSpec.md
  4. api-ts/packages/io-ts-http/docs/combinators.md
  5. api-ts/packages/io-ts-http/docs/httpRequest.md
  6. api-ts/packages/io-ts-http/docs/httpRoute.md

Tasks

  • Create reference documentation section in Docusaurus
  • Migrate technical reference content
  • Create explanation documents for conceptual understanding
  • Enhance existing how-to guides with examples from io-ts-http
  • Update README to be minimal with links to Docusaurus
  • Update navigation and sidebar in Docusaurus

Implementation Details

A detailed migration plan has been created in: io-ts-http-documentation-migration-plan.md

Success Criteria

  • All essential documentation is preserved and accessible
  • Documentation follows the Diátaxis framework
  • Redundancy is eliminated
  • Users can easily find the information they need

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions