Create documentation with write-the

[Wytamma]

Hi @eimenhmdt,

Awesome project! I've also been working on a GPT-CLI write-the (https://github.com/wytamma/write-the). I used the commands write-the docs and write-the mkdocs to create documentation for autoresearcher.

You can see a demo version of the site here -> https://blog.wytamma.com/autoresearcher/

[eimenhmdt]

Hey @Wytamma! Wow, that's awesome. Love it. And it updates the documentation automatically, right?

[Wytamma]

@eimenhmdt yep it pulls the API reference from the docstrings so if you update the docstrings it'll recreate the docs. If the code structure changes or you add new functions etc you can regenerate the docs with write-the mkdocs autoresearcher and that'll pull any functions with docstrings into the reference.

To get the site to go live you'll just have change your pages settings and the action will take care of the rest i.e.

[eimenhmdt]

That sounds excellent. Thanks for this amazing contribution!!

[eimenhmdt]

Sorry, maybe a stupid question haha, but how do I get the page to look like the demo page you sent me? :D

https://eimenhmdt.github.io/autoresearcher/

[Wytamma]

Ah you need to setup GitHub-Pages to deploy from the gh-pages branch should be here -> https://github.com/eimenhmdt/autoresearcher/settings/pages

@eimenhmdt you can see docs on how to do this here -> https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site

[eimenhmdt]

It worked! Thank you so much!!