eupolicy.social is one of the many independent Mastodon servers you can use to participate in the fediverse.
This Mastodon server is a friendly and respectful discussion space for people working in areas related to EU policy. When you request to create an account, please tell us something about you.

Server stats:

224
active users

#documentation

3 posts3 participants1 post today

I've been working a little bit on the @novelwriter documentation today as well. It's starting to look like what I was aiming for.

The PDF version is now 102 pages though. 😅

My goal is to structure it so that it naturally progresses from the basics to the technical stuff users don't need to know, but contributors and tinkerers do.

The key parts is about how to format plain text, and that is now at the very top, with more advanced features in the middle.

"How to leverage documentation effectively in Cursor through prompting, external sources, and internal context

Why documentation matters

Documentation provides current, accurate context. Without it, models use outdated or incomplete training data. Documentation helps models understand things like:

- Current APIs and parameters
- Best practices
- Organization conventions
- Domain terminology

And much more. Read on to learn how to use documentation right in Cursor without having to context switch."

docs.cursor.com/guides/advance

CursorCursor – Working with DocumentationHow to leverage documentation effectively in Cursor through prompting, external sources, and internal context

I generally like working with reStructuredText for technical documentation. I use it a lot both at work and on my own projects.

But the little detail that a single space off on the indentation turns something into a block quote, which happens *all the time* in lists with sub points, is rather annoying. They should have stuck with ">" for block quotes instead.

I see these accidental block quotes all the time in documentation.

📣 Help us improve the #GRASS docs!

We're updating the visuals in GRASS #documentation, and we are looking for 𝗶𝗻𝘁𝗲𝗿𝗲𝘀𝘁𝗶𝗻𝗴 𝘀𝗰𝗿𝗲𝗲𝗻𝘀𝗵𝗼𝘁𝘀 of various tools from the Graphical User Interface

🔧 Screenshots most needed:
Cartographic Composer
Raster Digitizer
Georectifier
Vector Network Analysis Tool
Animation Tool
3D View (NVIZ)
Scatter Plot Tool
Map Swipe Tool

🔗 If you have something cool, please send it to:
📩 linda.karlovska@seznam.cz

Thank you! 🙌 💚

Hawkmoth v0.21.0 is out.

Hawkmoth is a Sphinx extension to incorporate formatted C and C++ source code comments written in
reStructuredText into Sphinx based documentation.

v0.21.0 has improved support for documenting function pointer typedefs, fixes issues in looking up parsed results, and enables REUSE compliance.

jnikula.github.io/hawkmoth/sta

jnikula.github.ioHawkmoth – Sphinx Autodoc for C and C++ — Hawkmoth 0.21.0 documentation

"Welcome to the State of Docs Report 2025, bringing together insights from documentation experts from across the industry.

This comprehensive report explores how teams track their docs’ success, the future of the industry, the ongoing impact of AI on documentation, and much more.
(...)
We received responses from 444 hands-on documentation experts — including technical writers, managers, engineers, support teams, designers, marketers, and developer advocates. This variety shows just how many teams are involved and invested in documentation today.

We also conducted interviews with a number of technical writers, engineers, and documentation leaders from across the tech industry to get their insights into specific areas — you can read quotes from them throughout the report.

TAKEAWAYS:

- 54% believe their docs generate at least as many leads as their marketing sites

- 42% think AI will let us build docs that intelligently adapt to user needs

- 46% of large companies have decentralized or hybrid docs teams"

stateofdocs.com/2025/

www.stateofdocs.comState of Docs Report 2025Read the State of Docs Report 2025 and see what documentation professionals say about the state of the industry

#YunoHost: taking care of the ones that would be intimidated by self-hosting

:yunohost: We've just released the new YunoHost documentation engine to make it easier to get started with the solution: doc.yunohost.org/

:neopossum_laptop: To this end, we're planning to dedicate some time to update and clarify the documentation. Your support is invaluable in animating this process: yunohost.org/donate.html

doc.yunohost.orgYunohost | YunohostSemalibre SCOP <head />

#YunoHost : prendre soin d'accompagner les personnes que l'auto-hébergement intimide

:yunohost: Nous venons de publier le nouveau moteur de documentation de YunoHost afin de faciliter l'appropriation de la solution : doc.yunohost.org/

:neopossum_laptop: Pour cela, nous envisageons d'avoir des temps dédiés pour actualiser, simplifier et clarifier la documentation.

Votre soutien nous est précieux pour animer ce processus : yunohost.org/donate.html

doc.yunohost.orgYunohost | YunohostSemalibre SCOP <head />