Skip to content

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

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

Closed
6 tasks done
youngjungithub opened this issue Apr 4, 2025 · 2 comments
Closed
6 tasks done

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

youngjungithub opened this issue Apr 4, 2025 · 2 comments

Comments

@youngjungithub
Copy link
Contributor

youngjungithub commented Apr 4, 2025

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

Created PR #1032 to implement the documentation migration plan.

@youngjungithub
Copy link
Contributor Author

youngjungithub commented Apr 4, 2025

I've updated the PR #1032 to follow the Microsoft Writing Style Guide for all documentation content.

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

Successfully merging a pull request may close this issue.

1 participant