✨ Create a guide on how to update the documentation website

[asim-shrestha]

We should update the docs site (https://docs.reworkd.ai/development) with some documentation for how to update the docs site itself. It should cover the following:

• Intro on what mintlify is and link to it
• Talk about how to run the site locally
• Talk about how to update a page or create a new page
• Talk about exactly what we want documented
• Talk about how to request for documentation (Make an issue on GitHub!)

[MusabShakeel576]

@asim-shrestha maybe we could update the Docs README since we already have a guide on how to run the docs site locally. Alternatively, we could update the Docs Contributing file. Which option do you think would be better?

[momokid]

@asim-shrestha Hi, I would want to work on this issue.

[asim-shrestha]

@momokid please go for it!

[asim-shrestha]

Sorry I missed this @MusabShakeel576! I think a page on the docs site itself makes sense

[MusabShakeel576]

@asim-shrestha no worries. Yeah that would be good.

[jasangill1]

Hello @momokid Have you had any luck on this issue?? I can help you get started if not !!

[momokid]

Hi @jasangill1 , I will be glad with all the help I can get. I was checking out muntlify, but I had some challenges. Sorry for not reverting sooner

[jasangill1]

Hello @momokid what issues were u facing ??

[momokid]

I wanted to run the mintlify setup locally and try out how it works, but I got an error during the installation. I was advised to install the previous mintlify version, but again, I got an error.

[jasangill1]

are you using a new mintlify file? or are you running the AgentGPT docs?? What command are you running to start the mintlify server?

[momokid]

I am using the new mintlify file and I used the mintlify dev to start the mintlify server

[momokid]

@jasangill1 This is the snapshot of the error

[momokid]

@jasangill1 would you suggest I continue working on this issue without necessarily waiting for this bug to be fixed?

[jasangill1]

Hello @momokid could you try to run the command: yarn i -g mintlify

[momokid]

@jasangill1 sure.

[jasangill1]

Hello @momokid did anything change once that happened? If not I'm happy to help you get this going maybe over a discord call or some more screenshots !! https://discord.gg/tKE5JeGD

[momokid]

Hello @momokid did anything change once that happened? If not I'm happy to help you get this going maybe over a discord call or some more screenshots !! https://discord.gg/tKE5JeGD

I got this error when I run yarn i -g mintlfy but npm i -g mintlify runs just fine.

[momokid]

@jasangill1 Thank you so much for the support. I have finally set up the mintlify locally.

[jasangill1]

@momokid That's great to hear !!!! are you gonna to try tackling this issue now ?? i would love you help you through any question you may have on that

[momokid]

@momokid That's great to hear !!!! are you gonna to try tackling this issue now ?? i would love you help you through any question you may have on that

Thank you, @jasangill1 . I will start working on it and revert if I face any issues.

[momokid]

Hi @ja, I tried my hands on the mintlify and creating a sample docs using one of my repo. How do I go about creating the docs for AgentGPT using mintlify?

[jasangill1]

Hello @momokid are you able to clone the repository for agentGPT Please launch mintlify from there and create documents on how to launch mintlify !!!

[momokid]

@jasangill1 Thank you so much for the support. I am almost done and will submit the changes

[momokid]

@jasangill1 I am submitting the update with the commit message "Update documentation website guide #869". Is it ok?