Open meichthys opened 1 year ago
Actually I did quite a lot of work in this direction in the recent months, but there's quite a lot of complexity involved, and I'm not sure anymore if it's worth it, so I've paused the work for now.
Ok, If there's anything not too technical that I could help out with, just let me know.
I'd also be willing to help out with this, whether it be technical or otherwise.
@zadam Could you roughly outline the complexities that you were seeing when you looked at this previously?
Some things I remember:
I think there were some other ones, but it's been a couple months ...
I think the ability to have the help be in-app as well is great, but it feels like that would only contain documentation concerning real end-users, and not so much documentation on creating addons for Trilium. So that would also be another piece to tackle with this plan. Or do you think it should contain both end-user and developer docs, including the api reference?
As for keeping it and authoring it in git, it could be contained in a separate git repo and included via submodule or similar. Or even included by using it as an npm package (directly installed through github, no need to publish to npm).
IMO, I'd like to see the developer docs included too since many (most?) trilium users are power users who would benefit from the Dev docs.
@rauenzi I actually targeted end user, dev docs and API docs. That was another challenge, getting the jsdoc generated docs into something usable offline.
@zadam I gotcha, that's something I can definitely help with, I've got experience using JSDoc to output to non-web outputs like markdown (used here https://docs.betterdiscord.app/api/ source here https://github.com/BetterDiscord/docs/blob/main/docs/api/bdapi.md) so I'm sure we could use similar techniques to make it work with whatever you have in mind.
Describe feature
How cool would it be to host the Trilum wiki on Trilum itself!
Benefits
#widget
label!)Drawbacks