mark
diataxis-documentation-framework
mark | diataxis-documentation-framework | |
---|---|---|
4 | 72 | |
946 | 714 | |
- | - | |
8.5 | 8.7 | |
6 days ago | about 1 month ago | |
Go | HTML | |
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.
mark
-
Documentation as a service
Readme.md should be the very first source of documentation. From there we may have a nested “docs” directory all written in markdown and then as part of CI we sync that all into confluence on merges to dev using https://github.com/kovetskiy/mark
-
The Perks of a High-Documentation, Low-Meeting Work Culture
We use Mark[1] to automatically create Confluence pages from Markdown documents in our git repos. So we can have a review process for documentation changes, the documentation of the code can be in the repo with the code, and yet it can still be accessed without having to give permissions to view the code repo! Helpful with a proprietary monorepo.
[1] https://github.com/kovetskiy/mark
-
Ask HN: Software you hate but can't replace?
I used https://github.com/kovetskiy/mark at my last job where I had to use Confluence. It wasn't perfect and some touchup was generally needed after a sync but it definitely helped me stay sane.
-
An App's Single Source of Truth: Making the case for all resources in one repo
At the UAT/Production stage, the documentation is pushed to the Wiki using the extension of choice (most documentation parsers support the major wiki providers, like for Confluence there's Mark for Markdown, Official AsciiDoctor Exporter, and RST Exporter), or parsed into a DocBook/eBook/PDF for publishing.
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?
asciidoctor-confluence - Push Asciidoctor file to Confluence
technical-writing - A collection of materials relating to technical writing
Gitea - Git with a cup of tea! Painless self-hosted all-in-one software development service, including Git hosting, code review, team collaboration, package registry and CI/CD
documentation-framework - "The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework
go-atlassian - ✨ Golang Client Library for Atlassian Cloud.
awesome-writing - An awesome list of information to help developers write better, kinder, more helpful documentation and learning materials
lazygit - simple terminal UI for git commands
just - 🤖 Just a command runner
Gogs - Gogs is a painless self-hosted Git service
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
jingo - Node.js based Wiki
pgf - A Portable Graphic Format for TeX