How will developers interact with the DocGenie?

[nraychaudhuri]

Developers access documentation in many ways: Google, StackOverflow, ChatGPT, local documentation webserver, VScode or terminal (man pages ???). What should we focus on first?

Maybe we should do a high-level user journey mapping.

[nraychaudhuri]

@Himasnhu-AT thoughts?

[Himasnhu-AT]

I think, initially we should get started with VS-Code extension first. I actually prepared an overview of how it should work according to me: This is what i have though of building, any upgrades/ how is it?

• Begin with popular frameworks like Next.js, React, and Angular.

Features:

Free Tier:

• Redis Server Mapping:

  • Easily map data in the Redis server.
  • Choose a specific framework to start with.
  • Access a plethora of mapped functions and properties along with explanations for free.

• Bard Support:

  • Enjoy free support for Bard as well.
  • Bard api Key

Premium Tier:

• GPT-powered Assistance:
  • Unlock the full potential with our premium version, featuring GPT trained on the latest models.

Additional Features:

• Dedicated Discord Bot:

  • Get instant assistance and clear doubts through our dedicated Discord bot.

• External References:

  • Stack Overflow and Google searches for additional references.

[nraychaudhuri]

Nice. I like it. We can start with Vscode if it is easier. Do you think it's straightforward?

Follow-up questions:

• I like the idea of starting with popular frameworks. How do we deal with various versions? The fundamental goal of this project is to provide correct documentation.
• I'm not sure I follow the free tier/vs paid. We like to Open-source this. Ideally, the end user (developer) will plugin in their OpenAI or BardAI keys.

[Himasnhu-AT]

@nraychaudhuri

Nice. I like it. We can start with Vscode if it is easier. Do you think it's straightforward?

i believe starting with the VSCode is necessary as most of the developers use it, and it'll be easy to implement, just code to call certain actions in backend.

• I like the idea of starting with popular frameworks. How do we deal with various versions? The fundamental goal of this project is to provide correct documentation.

Maybe divide database as per versions? or make a base documentation, and any changes can be built over the base one. Like: User will tell framework + version, then the server will get appropriate data from base and the version changelog, give it too bot and return response.

• I'm not sure I follow the free tier/vs paid. We like to Open-source this. Ideally, the end user (developer) will plugin in their OpenAI or BardAI keys.

Yup, this can work too, i thought maybe we'll use our own keys. If we are taking user's key's, we would have to implement best security practices to prevent the data leaks.

[nraychaudhuri]

Why can't we automate the documentation fetch process? Given a build file, Genie should be smart enough to fetch the documentation for all the dependencies.

Example: For js projects, we get the list from package.json.

[Himasnhu-AT]

Yes, We can automate it with url fetching. Like: /fetch/:framework/:version

With this, backend can get best possible response