Since we have a new documentation site, I want to make sure that all the new stuff we’re adding in ProffieOS 7.x gets documented.
Unlike the alpha testing thread, where I go and update the top post as needed, I’m making this a wiki post, which should mean that anybody can update it.
Some things might not have an easy way to document it, but for now I will make space in the table for everything.
For props, I’ve limited the features to just the defines. Feel free to add additional entries as needed.
Yes, I meant to do that. I think I lready know the answer, but more of a question, doo we want to have the OS7 and later stuff together? What about OS6?
One way or another we need to spell out which enum values are new in OS7.
It’s probably easiest to do it sort of like we do with the defines, where new ones are just added at the bottom. I wouldn’t worry about spelling out what’s new in OS6, unless you really want to for some reason.
I’m back from vacations and have a free Saturday. I tried to make a changeset to add an index, but I can’t make the markdown-style reference-style links to work. I’ve read the documentation in the markdown site, but I can’t make a single variation of what I assume a link would be to work.
Any help? I would love to order that page, even put a (7.0+) besides those new effects, but if I can’t make the internal links work, I’m not sure it would be much help.
First of all, do we need an index?
We have a glossary, a list of all pages, and a search function already. The “list of all pages” and the search page are automatically generated, so they require no extra work.
Second, because of some of the auto-generating stuff, all links needs to be site-relative, so linking should look like this:
[Preset](/config/the-config_presets-section.html)
Unfortunately, wikiwords-like links do not work.
Also, because the links go to the html, not the md file, it’s not really possible to see if the links work in the preview on github.
The idea is that pages with lot’s of functions should have an ordered index on the top, like the Wikipedia pages. It makes navigating the long page faster. In this particular case, each effect has so little text that it’s not worth to put in a single page. But the sheer amount is so much that navigating the page is cumbersome. So I think there are only two reasonable options:
a) You separate the effects into groups (a grouping that would help with option (b) anyways), or
b) You separate in groups in the page with a index that allows you to easily navigate.
If it’s not possible, it’s not and then things should not change much.
Possibly a better way to add an index like this is to build a “leftnav”.
This would be automated and generate an index for all headers in the page.
The extra nice part is that it can be automated, so that it’s available for all pages and doesn’t require any extra work to maintain.
The leftnav would have to be in a pop-up or something on mobile though, otherwise it would steal too much screen real estate.
@profezzorn I moved the OS 7 labels below in my lastest pull request. But I’ve never used GitHub so I don’t know if you are watching that change or I have to make a new pull request.
I get emails when pull requests are updated.
If I fail to notice, or forget, please send me a PM.
Generally there should be no need to create new pull requests.
