rxjs-ninja
diataxis-documentation-framework
rxjs-ninja | diataxis-documentation-framework | |
---|---|---|
5 | 72 | |
78 | 741 | |
- | - | |
0.0 | 8.7 | |
over 1 year ago | about 1 month ago | |
TypeScript | HTML | |
MIT License | GNU General Public License v3.0 or later |
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.
rxjs-ninja
-
Do you still work on personal projects?
(As you can see from my previous side project it was back in Feb 2021 and then it was sort of abandoned https://rxjs-ninja.tane.dev/)
-
Introducing ArkType: The first isomorphic type system for TS/JS
For example the effort to update this library would mean now I'd have to update through TS version as a migration - trying to update to the latest just makes the code a huge effort to maintain and it's the reason I've sort of abandoned it.
-
RxJS utility for handling web serial streams.
This is a tutorial, along with a demo, on using the fromWebSerial utility function from the RxJS Ninja libraries. The tutorial is fairly short, but I think this just demonstrates how simple it makes interacting with the web serial API and getting a reactive stream to use with other reactive libraries, which in turn makes it much easier to define and handle different structures to the binary data. It also references a serial bluetooth app that might be useful experiments.
-
New to TS. Do any of you use TS exclusively over JS? If not exclusively, then what's the split between TS and JS? How do you decide when to use TS, and when to use JS?
I'm currently working on both Formula and RxJS Ninja and both are very type heavy and export all the comments - for me clear docs are important in a library.
-
Create your own Dark Mode Detection Observable using RxJS and Media Queries
You can check out the source code on GitHub.
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
What are some alternatives?
better-sqlite3-proxy - Efficiently proxy sqlite tables and access data as typical array of objects
documentation-framework - "The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework
input-mask - 🎭 @ngneat/input-mask is an angular library that creates an input mask
technical-writing - A collection of materials relating to technical writing
ts-toolbelt - 👷 TypeScript's largest type utility library
awesome-writing - An awesome list of information to help developers write better, kinder, more helpful documentation and learning materials
true-myth - A library for safer and smarter error- and "nothing"-handling in TypeScript.
just - 🤖 Just a command runner
msgpack-javascript - @msgpack/msgpack - MessagePack for JavaScript / msgpack.org[JavaScript/TypeScript/ECMA-262]
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
wrand - 🎲 Extract one or more random elements from a weighted array (aka loot table or gacha)
mark - Sync your markdown files with Confluence pages.