verb
diataxis-documentation-framework
verb | diataxis-documentation-framework | |
---|---|---|
15 | 72 | |
462 | 752 | |
- | - | |
8.0 | 8.7 | |
21 days ago | about 2 months ago | |
Emacs Lisp | HTML | |
GNU General Public License v3.0 only | 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.
verb
-
Emacs Advent Calendar 9: devdocs, code-cells, dREPL, etc.
plz-see: Interactive HTTP client, similar to restclient and verb, but using Elisp instead of a special text-based syntax.
- Beyond OpenAPI
- Emacs as REST API client?
-
RESTing with Emacs, or why EDN is better than JSON
Ah, btw. I just realized, verb's verb-send-request-on-point doesn't always properly work with source blocks. So I pushed a fix, PR is here.
-
Lama2: Plain-Text Powered REST API Client for Teams
have you checked this https://github.com/federicotdn/verb . Its emacs package and i am able to write and test api's with text files.
-
Hurl, run and test HTTP requests with plain text
Not as usable for testing, but verb.el[1] is a great tool for doing something very similar in org-mode
[1] https://github.com/federicotdn/verb
-
Has anyone ever tried using Google Sheets or Excel to journal?
I've been a long time user of the org-mode code blocks feature—storing runnable code block inline in the document. Something I've recently started using is verb to include HTTP requests in my documents when I'm testing out web APIs.
- Show HN: Restfox – A web based HTTP client inspired by Insomnia and Postman
-
How to use Tiddlywiki via REST API in Emacs
Looks also interesting, but it doesn't fit my use cases: I need custom functions to grab values/data from other sources (e.g. pocket-reader.el).restclient` is more about having pre-defined HTTP requests (path, headers, payload etc.) in a buffer and a major mode for executing the requests. Pretty much the same what verb offers.
-
HTTPie/cURL client for Emacs?
There is also verb.el.
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?
ob-http - make http request within org-mode babel
documentation-framework - "The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework
restclient.el - HTTP REST client tool for emacs
technical-writing - A collection of materials relating to technical writing
emacs-request - Request.el -- Easy HTTP request for Emacs Lisp
awesome-writing - An awesome list of information to help developers write better, kinder, more helpful documentation and learning materials
httpyac - Command Line Interface for *.http and *.rest files. Connect with http, gRPC, WebSocket and MQTT
just - 🤖 Just a command runner
stepci - Automated API Testing and Quality Assurance
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
org-fancy-priorities - Display Org Mode priorities as custom strings
mark - Sync your markdown files with Confluence pages.