It says somewhere in the blur of reference I’ve looked over the last few days that help with documentation is always helpful or such (main Haiku repo on github?). Just wondering the preferred formats, as I have SilverBullet for .md (it can also export .html), many PDF tools and from Google docs to lots of others. I’ve also got a hugo system for static sites from .md. I mean to say that I prefer .md as a start, but what’s the preferred consistent “export” (eventual automation) that’s well preferred for bundling into effectively a .chm thing?
EDIT: I mean a simple .js loader of .md with transform to html DOM, and an include of less.js for CSS, … SilverBullet is in rust so not sure if compiling it as a localhost server makes any sense for Haiku. It is nice though.
EDIT: Or a native app with plugin views, and maybe a curl to external markdown links. Imagine none of the browser js code, and none of the serialization http of local md, with maybe server side restrictions on pre-scripting, adding edits personal to you to the immutable documentation, by some kind of inflator/injector at anchor points in the immutable. Maybe the local edit page has the inserts of anchored immutables. Kind of a linked (not embedded) writable cloned page (checked in local storage) before an immutable fetch.
I can’t really make heads or tails of the rest of what you’re saying there, but as far as I know the main documentation format is HTML.
The structure of the pages are already standardized, so it’d probably be best to just work in HTML rather than trying to get a tool to output pages that look like the existing documentation?
Any native app or port, is there a documentation best format (not code comment based API Doxygen).
Any documentation which might be cherry picked for composition efficiency.
Third party is likely in anything
For example on ramdisk is it likely that it accepts a file which is also a name? And how is the raw device known pre-mount on the restoring a saved RAM disk? An the whole BServer private undersomething or other → Just use a BApplication with flags.
I believe it depends on what kind of help guide you’re looking at exactly. The four places PulkoMandy mentioned are the existing places it could go, so you would have to look at which one works the best for what you’re hoping to write.
I know Icon-O-Matic’s documentation is here. It might give you an idea for where documentation for other native apps would go. (By the way, if you’re interested in writing documentation for Icon-O-Matic, I believe there are some holes there that I can point you to.) As far as ports go, I’m not so sure. Maybe they go with the upstream project?
I don’t quite understand. Are you are wondering if paragraphs of documentation in one place can be reused in different areas effectively?
I’m not a developer, unlike previous respondents, I’m just a curious Haiku end user who sometimes comments on a post when it might be wiser to keep quiet.
Well, I don’t mean to offend you, but it wasn’t entirely clear to me whether
maybe you want to develop / port an application so that you can work in it when using Haiku, just like on another OS
or you’re asking so that you can write documentation for this application you’re developing, and you want to know what the basics are, how this doc is created in the case of a Haiku application, what is the method to make it available …
In that case, all my respect is yours …
but why don’t you ask this directly?
Then maybe the developers wouldn’t be groping in the dark and answering you either!
AGAINST
if you are one of those people - this has happened here on the forum - who doesn’t say what they want because they are still wondering if they can reveal that they know everything, how it should really work, because they know the perfect solution… then it will break the invested work of those who currently operate it, the way things are going.
If you do it voluntarily, you prove it somehow: it’s good. Maybe they will even consider implementing it.
If you just talk about it, because there have been many of them, because it’s not just developers who dream sometimes, then that idea will bounce off the wall of the working system.
Not because it’s the best, not because it couldn’t be made better, but because those who work with it understand how it works, put in the volunteer hours, and in the best case, they get a thank you for all of it. Oh, and most importantly, it works because they operate it.
I wrote all this in the hope that you would express yourself more directly than you did in your first post on this topic, because honestly, what you wrote was in English, so it didn’t need a translator on a linguistic level, but what you were trying to get across was not entirely clear even to the number of people who answered before me, although believe me, they are smarter than me on a logical level. For my part, I gave up coding to train my brain decades ago, so that’s why I wrote it.
I hope what I wrote was not offensive in any way, I just wanted to share my opinion with you that if your communication was clearer, more direct, then you would get the answer you want faster and in a more efficient form, and - who was red and composed answers to you -wouldn’t have to wonder: what do you really want to know?
(P.S. If I went too far yet, moderators will defend you and the community from me, suspending this post )
It is out of self interest I ask, as I’d prefer to write more and better documentation for something I code, as yet undecided, due to reading API documentation and still in the process of familiarizing myself with the current software pool. Converting from or adding extra, both taking time.
I’m doing my idea notes in markdown at present. With occasional Google Tasks on Android/Mobile.
There’s things like some of the HTML might be generated so where would the source be, and would it be HTML? It’s a noob question, but Gemini only answers so much and is often wrong.
Don’t worry about offending me, I often wouldn’t care to notice as people often have no intent to do so. Something to do with the lack of intonation being inferred from text and not heard but imagined?
I’m occasionally listening to the Belle Stars, Iko, Iko.
Ok, I’d rather switch off myself of it, as this is how you will communicate, because this is how you simply work.
I understood from your answer that you eventually want to develop something (or not) and so ..
you wanted to understand what the method is in the case of Haiku environment and apps running on it.
But instead of answering simply to me that you are the first case from my post, you wrote an essay or something.
I admit that I also write long posts, but I just met someone who writes long ones differently than me.
I got a mirror case in my face, how others can feel if they get my long expressing answer and want a shorter condensed one. Right.
The offense part acknowledged - generally I also skip it as I know short temper ( oh yeah there was a long way to learn to cool it for myself) – however I learned recently : sometimes you have to set boundaries despite all patience stuff.
Otherwise …
Be careful with cultural referrals and idioms - like
This is international environment, so the possibility is high enough you won’t be on the same page - as English? American ? saying says so – with other forum members or other readers from the internet …
(And you won’t lure me in the rabbit hole of internet to dig up what this sentence ment. )
)
)
What information are you looking to publish exactly? Is it your idea notes or is it the project documentation?