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

Create documentation with write-the #4

Merged
merged 3 commits into from
Apr 25, 2023

Conversation

Wytamma
Copy link
Contributor

@Wytamma Wytamma commented Apr 25, 2023

Hi @AkshitIreddy!

Awesome project :) I saw it on reddit 🧁 I've been working on write-the an AI-powered documentation and test generation tool.

I used 2 write-the commands to build a documentation website for your project. You can see a demo of the site here -> https://blog.wytamma.com/CUPCAKEAGI/

I use the command write-the docs to add docstrings to your project and the command write-the mkdocs to build a mkdocs website for CUPCAKEAGI.

If you merge this PR you'll just have to setup github pages to deploy the site from the gh-pages branch and then your site will be live here -> https://AkshitIreddy.github.io/CUPCAKEAGI

image

@AkshitIreddy
Copy link
Owner

wow thanks

@AkshitIreddy AkshitIreddy merged commit 094bfd1 into AkshitIreddy:master Apr 25, 2023
@AkshitIreddy
Copy link
Owner

Yep i can see the website now and there's a nice doc string for each function , write the is a pretty nice tool! saved me the trouble of having to write the docs for all these functions😊

@Wytamma
Copy link
Contributor Author

Wytamma commented Apr 25, 2023

Glad you like it 😄 the future will be well documented!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants