Hey, I know this software 😆
Programming
Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!
Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.
Hope you enjoy the instance!
Rules
Rules
- Follow the programming.dev instance rules
- Keep content related to programming in some way
- If you're posting long videos try to add in some form of tldr for those who don't want to watch videos
Wormhole
Follow the wormhole through a path of communities !webdev@programming.dev
:)
:) and what do you think?
Voiden files combine frontmatter, Markdown, and structured void request blocks so the request and the documentation live together.
This is... An interesting format. Why not just move the front matter field and markdown into the "structured" bit and just have a single thing to parse? Or at least combine the frontmatter and structured bit since they're both yaml anyway?
Interesting point. Are you thinking about this from the parser/tooling side, or from the person writing and reviewing the file?
We intentionally started from Markdown because we wanted .void files to stay standards-compliant and not reinvent a new document format. Markdown already gives us a familiar, portable way to write docs, notes, examples, and explanations around the request.
Frontmatter handles the document-level metadata, Markdown stays the human-readable documentation layer, and the structured Voiden blocks handle the executable API parts.
We could put everything into one YAML object, but then the file becomes more like a config file than a Markdown document. The tradeoff we’re making is: keep the file readable in GitHub, PRs, and plain text editors while it still gives Voiden enough structure to execute requests reliably.
From both a tooling and user POV.
We intentionally started from Markdown because we wanted .void files to stay standards-compliant and not reinvent a new document format.
Unless I'm missing something you kinda have though? You've got a frontmatter bit followed by a MD document with a "footer" that has configuration in it?
We could put everything into one YAML object, but then the file becomes more like a config file than a Markdown document.
It seems like a config file to me. But reading through your documentation about blocks it seems like you're aiming to be something like Jupyter for REST? It's very confusing.
It would be perfect as a CLI and LSP combo.
That's a great observation !
TL;DR
Is it GUI only?
No it does have a CLI too and we are planning for a CLI runner very very soon !
So what does the existing CLI do if it is not a runner?
It right now helps in opening a specified file or directory in Voiden, see the version, etc.
You can check out more in the docs here : https://docs.voiden.md/docs/developer-tools/voiden-cli