Table of Contents
I wanted a way to utilize GPT's article generation and build out extensive documentation without having to endlessly prompt ChatGPT. The idea was to start with a high level topic and seamlessly generate a child article based on a subsection of the original article. This would create an intuitive way to quickly build out a document tree for the given topic.
As I developed the project, I decided to lean in to the co-creation aspect. I added the ability to prompt GPT directly to edit the article or generate an article on a specific subtopic not included in the parent article to build out the document tree exactly how they want it.
Ideally the next major feature would be the ability to link a code repo directly and generate high quality documentation from the source code.
- React + Next.js - Frontend framework + Serverless API
- JavaScript + TypeScript - Languages
- Tailwind CSS - Styling
- Material UI - UI framework
- Firebase - Authentication
- MongoDB - Database
The following steps will get you a copy of the project up and running on your local machine for development and testing purposes.
- Node.js
- npm
- MongoDB
- Firebase
-
Clone the repo
git clone https://github.com/jhawkins11/doc-genie.git -
Install dependencies npm install
-
Create a
.env.localfile in the root directory
In the .env.local file, add the following:
OPENAI_API_KEY- Get this from your OpenAI accountNEXT_PUBLIC_FIREBASE_API_KEY- Get this from your Firebase project settingsNEXT_PUBLIC_FIREBASE_AUTH_DOMAINNEXT_PUBLIC_FIREBASE_PROJECT_IDNEXT_PUBLIC_FIREBASE_STORAGE_BUCKETNEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_IDNEXT_PUBLIC_FIREBASE_APP_IDMONGODB_URI- Follow docs to get MongoDB connection string
npm run dev- start dev servernpm run build- build for production
Doc Genie allows you to quickly generate extensive documentation using AI. Follow these steps to get started:
-
Sign up and login.
-
On the homepage, enter a high-level topic to generate the initial doc.
-
Review the generated parent doc. If needed, click "Edit with GPT" at the bottom of the doc to prompt GPT to edit the doc.
-
Select a sub-section you want to expand on and click the lamp icon to generate a child doc. Alternatively, you can click the "+" icon to manually create a child doc for a custom child doc.
-
The child doc will be added to the document tree. Repeat steps 4-5 to keep building out the tree.
- Access your generated docs anytime by clicking the profile icon in the top right corner and selecting "My Docs".
Some key features:
- Seamlessly generate a document tree with AI
- Manually create docs with custom prompts
- Edit generated docs with GPT
- Access generated docs anytime from your profile
- View all generated article trees
- Edit/View mode
- Manual article editing
- Delete articles
- Subscription model
- Private articles
- Export to markdown/pdf
- Code repo integration
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a pull request
Josiah Hawkins - LinkedIn - [email protected]
Project Link: https://github.com/jhawkins11/doc-genie
Distributed under the MIT License. See LICENSE for more information.