diataxis-documentation-framework
SQLite
diataxis-documentation-framework | SQLite | |
---|---|---|
72 | 40 | |
714 | 5,537 | |
- | - | |
8.7 | 0.0 | |
about 1 month ago | 3 days ago | |
HTML | C | |
GNU General Public License v3.0 or later | 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.
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
SQLite
- Show HN: Roast my SQLite encryption at-rest
-
A SQLite extension that brings column-oriented tables to SQLite
If you are into alternative storage engines for SQLite, there is also an LSM (Log-Structured Merge-tree) extension in the main repository that is not announced nor documented but seems to work. It’s based on the SQLite 4 project.
https://github.com/sqlite/sqlite/tree/master/ext/lsm1
https://www.charlesleifer.com/blog/lsm-key-value-storage-in-...
- SQLite License
-
Ask HN: Where do I find good code to read?
The sqlite code base is really well done. Lots of documentation.
https://github.com/sqlite/sqlite
-
Show HN: I wrote a RDBMS (SQLite clone) from scratch in pure Python
Especially the VM part: https://github.com/spandanb/learndb-py/blob/master/learndb/v...
Compare it with this: https://github.com/sqlite/sqlite/blob/master/src/vdbe.c
That's said, I'm curious how complete this LearnDB is. SQLite is hard to read not only it's old but also it covers a lot of SQL and following SQL spec makes hings complicated. SQLite has great test suite so it's nice if you run the suit against this implementation.
-
SQLite Begin Concurrent
Correct, see the github mirror[1]. I don't know how well supported that feature is compared to main branch. If it was completely stable, then it would have already landed in the main stable branch. Clarity about the roadmap of that branch would be nice.
1. https://github.com/sqlite/sqlite/tree/begin-concurrent
- Why sqlite3 temp files were renamed 'etilqs_*' (2006)
- SQLite builds for WASI since 3.41.0
-
SQLite VS sqlite_blaster - a user suggested alternative
2 projects | 17 Mar 2023
-
Stop Saying “Technical Debt”
Including comprehensive comments, documentation and tests in a codebase takes time and effort.
Failing to do so creates code that is very difficult to maintain or for someone new to the codebase to understand.
However, time and effort may not be what the organization wants to pay for, and individuals may view their own incomprehensible code as something like job security, as they can't be replaced by someone else easily.
As an example of complicated code that's still well-documented, the open-source sqlite code is a good example, about 1/4 of the B-tree file is comments, every time a variable is defined there's a short note explaining what it's used for, every function has a comment header that's comprehensive, such that someone new to the codebase could construct a map of how it all works fairly quickly. It's a good model for how to avoid the problem:
https://github.com/sqlite/sqlite/blob/master/src/btree.c
What are some alternatives?
technical-writing - A collection of materials relating to technical writing
sqlcipher - SQLCipher is a standalone fork of SQLite that adds 256 bit AES encryption of database files and other security features.
documentation-framework - "The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework
LevelDB - LevelDB is a fast key-value storage library written at Google that provides an ordered mapping from string keys to string values.
awesome-writing - An awesome list of information to help developers write better, kinder, more helpful documentation and learning materials
RocksDB - A library that provides an embeddable, persistent key-value store for fast storage.
just - 🤖 Just a command runner
sqlite_orm - ❤️ SQLite ORM light header only library for modern C++
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
bolt
mark - Sync your markdown files with Confluence pages.
phpMyAdmin - A web interface for MySQL and MariaDB