Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm aiming to move away from the GitHub Wiki to a dedicated documentation site that gives some more power and control over the site.
The new docs site is built with Astro and Starlight. Markdown files are pulled in from this repo to keep updating docs centralised and simple as possible. They are then automatically converted into
.mdxwith the added functionality added in at build time.Primarily, module configs no longer need to be manually documented. Instead, the JSON schema that Ironbar already generates is used. This is used to generate each page's configuration section and automatically includes all the information that's already present.
Config options are now listed out as headers and sections on a page, rather than one large table. This makes some of the more complex module documentation less cramped and provides much more room to provide additional detail inline where appropriate.
Configuration examples also do not need to be written out in all 4 supported languages. Instead, only the Corn format needs to be included. The code blocks are pulled out and converted into tabbed views for each format. This is achieved using corn.js.
Code can be found here:
https://github.com/JakeStanger/ironbar-docs/
The site is live but there's a good few issues to work through before this is stable. My primary focus has been on the module pages, so the others are lacking the new features and still need a good comb through.
https://ironb.ar/modules/clock
(no homepage yet...)
Any immediate feedback is appreciated.
This PR also includes a few minor fixes to existing documentation I found along the way. In some cases, properties that were not manually documented are now correctly documented on the site.
PS: you can also use
https://ironb.ar/gh/*as a shorthand redirect to this repo. Probs not useful for anybody except me, but I have to get here a lot :PRemaining tasks:
repository_dispatchevent)