📝 Backlog the README walkthrough restoration
The example-code removal stripped the synopsis and examples with the template modules; track bringing them back around the real API, with the previous section order recorded so its placement is not re-guessed.
This commit is contained in:
1 parent
16092350b8
commit
65e885989b
1 file changed
+3
@@ -34,6 +34,9 @@ Enhancements:
|
|||||||
☐ Are there other primitive types that should be supported in union patterns? (e.g. `bigint`, `symbol`) @medium
|
☐ Are there other primitive types that should be supported in union patterns? (e.g. `bigint`, `symbol`) @medium
|
||||||
|
|
||||||
Documentation:
|
Documentation:
|
||||||
|
☐ Bring README.md back to its previous form — synopsis and examples restored, in the correct place
|
||||||
|
→ previous section order: title, tagline, Synopsis, Description, Requirements, Examples, API, License, Contributing
|
||||||
|
→ previous Examples order: literal/exhaustive, typeof, structural/discriminated unions, when, any
|
||||||
☐ Create `examples/` directory with runnable snippets
|
☐ Create `examples/` directory with runnable snippets
|
||||||
☐ Add comparison section vs. other TS pattern-matching libs in Readme.md
|
☐ Add comparison section vs. other TS pattern-matching libs in Readme.md
|
||||||
☐ Write migration guide for users coming from discriminated unions
|
☐ Write migration guide for users coming from discriminated unions
|
||||||
|
|||||||
Reference in new issue
Block a user