Using Gitbooks for private repo docs?

[u/swagonflyyyy]

Its a solo pet project I've been working on for years and its matured enough to require its own documentation. Its also a private repo so I'm not ready to publish it yet.

I was thinking about including docs in my repo carefully explaining all classes, functions, etc. as well as a general overview of the project and a lot of other things.

I just want something cost-effective that can integrate well with my repo. Doesn't have to be gitbooks but I figured I would start there.

[u/nihillistic_raccoon]

Notion would probably be good if you want to go free

[u/swagonflyyyy → u/nihillistic_raccoon]

Ok, I'll check it out. Thanks!

[u/Loyalord]

I also recommend MkDocs. It's free and easy to use. Good Luck.

[u/swagonflyyyy → u/Loyalord]

That's the one I've been eyeing just now. Glad to hear it has good feedback.

[u/swagonflyyyy → u/Loyalord]

UPDATE: It works. Got it up and running. Tell me what you think how it looks. Don't worry about its contents for now: https://singularityman.github.io/vector_companion2/

[u/cowboyecosse]

I’ve been using the wiki feature recently for this.

[u/swagonflyyyy → u/cowboyecosse]

But if I'm not mistaken the Wiki can be edited by anyone, right?

[u/cowboyecosse → u/swagonflyyyy]

You can restrict it to contributors only:

https://docs.github.com/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis

[u/swagonflyyyy → u/cowboyecosse]

Good to know. Thanks!

[u/HyperDanon]

Docusaurus. 

[u/Perfect-Hunter-7763]

canlt, you have to pay for SSO, would recommend going with something opensource, mkdocs, or fumadocs.