lune-climate / ts-results-es

A TypeScript implementation of Rust's Result and Option.
MIT License
93 stars 8 forks source link

Move the ts-results fork documentation out of the readme #150

Closed jstasiak closed 2 months ago

jstasiak commented 2 months ago

Following up on the work started in [1].

Applied some necessary changes to the content since we're migrating from Markdown to reStructuredText.

Following the Diataxis framework[2] for structuring the documentation.

[1] 633ccad330e8 ("Set up an initial documentation structure (#81)") [2] https://diataxis.fr/

jstasiak commented 2 months ago

We're following https://diataxis.fr/ here.

Open question, should it be "Explanations" or maybe something else?

jstasiak commented 2 months ago

Yup, I'll change to Explanation