diataxis-documentation-framework
zod
diataxis-documentation-framework | zod | |
---|---|---|
72 | 290 | |
714 | 30,477 | |
- | - | |
8.7 | 9.1 | |
about 1 month ago | 3 days ago | |
HTML | TypeScript | |
GNU General Public License v3.0 or later | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
diataxis-documentation-framework
- How-To Document: The Documentation System
- Diátaxis
-
The IDEs we had 30 years ago and we lost
Perhaps it could be restructured to separate out the howto from the explanation to serve the reader’s intended use at the time as described here: https://diataxis.fr
-
Lessons in Leadership Excellence
Create an organized repository for regularly updated documentation, making it easy to access important information.
- Docs Deserve More Respect
-
Nx Conf 2023 - Recap
Such integration capabilities really help push the developer productivity, whether that's in single-project workspaces or monorepos. Juri also dives deeper into efforts from the team to provide high quality educational content around Nx and its capabilities. The Nx docs have been restructured to follow the Diataxisframework, dividing content into into learning-, task-, understanding- and information-oriented sections.
-
Beyond OpenAPI
I think people may be missing the core point of this article.
Anton has built a new thing, https://codapi.org/ - which provides a web component that makes it easy to embed interactive code snippets for HTTP APIs, Python code and more directly in pages of documentation.
This article demonstrates this new technology in the context of the https://diataxis.fr/ documentation framework, which recommends going beyond just straight API reference documentation and ensuring you cover tutorials, how-to guides and explanations as well.
I think this is really cool.
-
Where is the documentation for the text models
As much as possible on all facets, because that is what "documentation" means, and if you are a product manager who wasn't paying attention in product management 101 and need some guidance on what "documentation" is, try reading this first.
-
The PostgreSQL Documentation and the Limitations of Community
Related: Diátaxis - A systematic framework for technical documentation authoring [1]
"The Diátaxis framework aims to solve the problem of structure in technical documentation. It adopts a systematic approach to understanding the needs of documentation users in their cycle of interaction with a product.
Diátaxis identifies four modes of documentation - tutorials, how-to guides, technical reference and explanation. It derives its structure from the relationship between them.(...)"
[1] https://diataxis.fr/
-
The Surprising Power of Documentation
the divio style docs concept got further refined by the creator with this - https://diataxis.fr/
mostly the same but some additional information for people who are interested
zod
-
Simplifying Form Validation with Zod and React Hook Form
[Zod Documentation](https://zod.dev/) [Zod Error Handling](https://zod.dev/ERROR_HANDLING?id=error-handling-in-zod) [React-Hook-Form Documentation](https://react-hook-form.com/get-started) [Hookform Resolvers](https://www.npmjs.com/package/@hookform/resolvers)
-
Figma's Journey to TypeScript
This is a very fair comment, and you seem open to understanding why types are useful.
"problems that are due to typing" is a very difficult thing to unpack because types can mean _so_ many things.
Static types are absolutely useless (and, really, a net negative) if you're not using them well.
Types don't help if you don't spend the time modeling with the type system. You can use the type system to your advantage to prevent invalid states from being represented _at all_.
As an example, consider a music player that keeps track of the current song and the current position in the song.
If you model this naively you might do something like: https://gist.github.com/shepherdjerred/d0f57c99bfd69cf9eada4...
In the example above you _are_ using types. It might not be obvious that some of these issues can be solved with stronger types, that is, you might say that "You rarely see problems that are due to typing".
Here's an example where the type system can give you a lot more safety: https://gist.github.com/shepherdjerred/0976bc9d86f0a19a75757...
You'll notice that this kind of safety is pretty limited. If you're going to write a music app, you'll probably need API calls, local storage, URL routes, etc.
TypeScript's typechecking ends at the "boundaries" of the type system, e.g. it cannot automatically typecheck your fetch or localStorage calls return the correct types. If you're casting, you're bypassing the type systems and making it worthless. Runtime type checking libraries like Zod [0] can take care of this for you and are able to typecheck at the boundaries of your app so that the type system can work _extremely_ well.
[0]: https://zod.dev/ note: I mentioned Zod because I like it. There are _many_ similar libraries.
-
From Flaky to Flawless: Angular API Response Management with Zod
Zod is an open-source schema declaration and validation library that emphasizes TypeScript. It can refer to any data type, from simple to complex. Zod eliminates duplicative type declarations by inferring static TypeScript types and allows easy composition of complex data structures from simpler ones. It has no dependencies, is compatible with Node.js and modern browsers, and has a concise, chainable interface. Zod is lightweight (8kb when zipped), immutable, with methods returning new instances. It encourages parsing over validation and is not limited to TypeScript but works well with JavaScript as well.
- TypeScript Essentials: Distinguishing Types with Branding
-
You can’t run away from runtime errors using TypeScript
Zod is a TypeScript-first schema declaration and validation library. It helps create schemas for any data type and is very developer-friendly. Zod has the functional approach of "parse, don't validate." It supports coercion in all primitive types.
-
Best Next.js Libraries and Tools in 2024
Link: https://zod.dev/
-
Popular Libraries For Building Type-safe Web Application APIs
You can check out their documentation here.
-
Epic Next JS 14 Tutorial Part 4: How To Handle Login And Authentication in Next.js
You can learn more about Zod on their website here.
-
What even is a JSON number?
In JS, it's a good idea anyway to use some JSON parsing library instead of JSON.parse.
With Zod, you can use z.bigint() parser. If you take the "parse any JSON" snippet https://zod.dev/?id=json-type and change z.number() to z.bigint(), it should do what you are looking for.
-
Error handling in our form component for the NextAuth CredentialsProvider
We will validate our input using client-side zod. Zod handles TypeScript-first schema validation with static type inference. This means that it will not only validate your fields, it will also set types on validated fields.
What are some alternatives?
technical-writing - A collection of materials relating to technical writing
class-validator - Decorator-based property validation for classes.
documentation-framework - "The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework
joi - The most powerful data validation library for JS [Moved to: https://github.com/sideway/joi]
awesome-writing - An awesome list of information to help developers write better, kinder, more helpful documentation and learning materials
typebox - Json Schema Type Builder with Static Type Resolution for TypeScript
just - 🤖 Just a command runner
Yup - Dead simple Object schema validation
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
ajv - The fastest JSON schema Validator. Supports JSON Schema draft-04/06/07/2019-09/2020-12 and JSON Type Definition (RFC8927)
mark - Sync your markdown files with Confluence pages.
io-ts - Runtime type system for IO decoding/encoding