Skip to content

Migrate io-ts-http documentation to Docusaurus website #1032

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 3 commits into from
Closed

Migrate io-ts-http documentation to Docusaurus website #1032

wants to merge 3 commits into from
+636 −341

Conversation

youngjungithub
Copy link
Contributor

@youngjungithub youngjungithub commented Apr 4, 2025 •
edited
Loading

Documentation Migration: io-ts-http to Docusaurus

Description

This PR migrates documentation from the io-ts-http package to the centralized Docusaurus website following the Diátaxis framework. The goal is to eliminate redundancy while ensuring all essential information is preserved and organized properly.

Changes

  • Created a new reference section in Docusaurus with detailed documentation for:
    • apiSpec
    • httpRoute
    • httpRequest
    • combinators
  • Simplified the io-ts-http README.md to contain only essential information with links to the comprehensive documentation

Testing

  • Verified that all content from the original documentation has been preserved
  • Checked that links between documents work correctly
  • Ensured the documentation follows the Diátaxis framework principles

Fixes #1031

@youngjungithub youngjungithub requested review from a team as code owners April 4, 2025 16:11
@youngjungithub youngjungithub mentioned this pull request Apr 4, 2025
Closed
6 tasks
@youngjungithub youngjungithub marked this pull request as draft April 4, 2025 16:11
@youngjungithub
Migrate io-ts-http documentation to Docusaurus website following Diát…
2b35561 
…axis framework

Update documentation to follow Microsoft Writing Style Guide

chore: prettier

Remove io-ts-http-documentation-migration-plan.md
@youngjungithub youngjungithub force-pushed the docs/io-ts-http-migration branch from fb506e8 to 2b35561 Compare April 4, 2025 16:45
@youngjungithub youngjungithub marked this pull request as ready for review April 4, 2025 17:45
@youngjungithub youngjungithub marked this pull request as draft April 9, 2025 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation Migration: io-ts-http to Docusaurus website
1 participant
@youngjungithub