Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use markdown for docs on wiki? #505

Open
goodboy opened this issue May 1, 2023 · 0 comments
Open

Use markdown for docs on wiki? #505

goodboy opened this issue May 1, 2023 · 0 comments
Labels

Comments

@goodboy
Copy link
Contributor

goodboy commented May 1, 2023

We obviously need docs 😂

One of the reasons we haven't written many (besides everything being in
bleeding edge flux atm) is that I don't love sphinx and I don't love
editing markdown from web UI editors..

I started using obsidian a few days ago and i'm kinda sold on it
being the best tina-ready app for doing org-mode like things.

BUT IT A'INT FOSS boss..

Why:


Wut we need for docs on wiki

As preface take a look at how ranger does it's user guide on the github
wiki

https://github.com/ranger/ranger/wiki/Official-user-guide

Ideally we can have the src code and docs all together on the wiki and
managed entirely through git + obsidian. This would allow our
non-coder users to edit either using GH's web UI directly or if they so
choose to use obsidian. Obviously i think devs will want the latter
😂

research:

Probably much more to come on this..

@goodboy goodboy added the docs label May 1, 2023
@goodboy goodboy changed the title Use obsidian for docs on wiki? Use markdown for docs on wiki? May 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant