diataxis-documentation-framework
fastapi
diataxis-documentation-framework | fastapi | |
---|---|---|
72 | 469 | |
714 | 71,023 | |
- | - | |
8.7 | 9.8 | |
about 1 month ago | 8 days ago | |
HTML | Python | |
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
fastapi
-
Github Sponsor Sebastián Ramírez Python programmer
He is probably most well know for creating FastAPI that I taught to some of my clients and Typer that I've never used.
-
Python: A SQLAlchemy Wrapper Component That Works With Both Flask and FastAPI Frameworks
It has been an interesting exercise developing this wrapper component. The fact that it seamlessly integrates with the FastAPI framework is just a bonus for me; I didn't plan for it since I hadn't learned FastAPI at the time. I hope you find this post useful. Thank you for reading, and stay safe as always.
-
FastAPI Best Practices: A Condensed Guide with Examples
FastAPI is a modern, high-performance web framework for building APIs with Python, based on standard Python type hints.
-
Building an Email Assistant Application with Burr
In this tutorial, I will demonstrate how to use Burr, an open source framework (disclosure: I helped create it), using simple OpenAI client calls to GPT4, and FastAPI to create a custom email assistant agent. We’ll describe the challenge one faces and then how you can solve for them. For the application frontend we provide a reference implementation but won’t dive into details for it.
-
FastAPI Got Me an OpenAPI Spec Really... Fast
That’s when I found FastAPI.
-
How to Deploy a Fast API Application to a Kubernetes Cluster using Podman and Minikube
FastAPI & Uvicorn
-
Analysing FastAPI Middleware Performance
Discussion at FastAPI GitHub: https://github.com/tiangolo/fastapi/issues/2696
-
LangChain, Python, and Heroku
An API application framework (such as FastAPI)
-
Litestar – powerful, flexible, and highly performant Python ASGI framework
It’s been my experience that async Python frameworks tend to turn IO bound problems into CPU bound problems with a high enough request rate, because due to their nature they act as unbounded queues.
This ends up made worse if you’re using sync routes.
If you’re constrained on a resource such as a database connection pool, your framework will continue to pull http requests off the wire that a sane client will cancel and retry due to timeouts because it takes too long to get a connection out of the pool. Since there isn’t a straightforward way to cancel the execution of a route handler in every Python http framework I’ve seen exhibit this problem, the problem quickly snowballs.
This is an issue with fastapi, too- https://github.com/tiangolo/fastapi/issues/5759
-
AI-Powered Image Search with CLIP, pgvector, and Fast API
Fast API.
What are some alternatives?
technical-writing - A collection of materials relating to technical writing
AIOHTTP - Asynchronous HTTP client/server framework for asyncio and Python
documentation-framework - "The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework
HS-Sanic - Async Python 3.6+ web server/framework | Build fast. Run fast. [Moved to: https://github.com/sanic-org/sanic]
awesome-writing - An awesome list of information to help developers write better, kinder, more helpful documentation and learning materials
Tornado - Tornado is a Python web framework and asynchronous networking library, originally developed at FriendFeed.
just - 🤖 Just a command runner
django-ninja - 💨 Fast, Async-ready, Openapi, type hints based framework for building APIs
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
Flask - The Python micro framework for building web applications.
mark - Sync your markdown files with Confluence pages.
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.