context-labs / autodoc

Experimental toolkit for auto-generating codebase documentation using LLMs
MIT License
1.93k stars 113 forks source link

Introduce Prompt customization into config #10

Closed andrewhong5297 closed 1 year ago

andrewhong5297 commented 1 year ago

This PR adds filePrompt, folderPrompt, chatPrompt, contentType, and targetAudience into the config to make prompts more flexible.

Ideally, in the future, you could choose some preset for code, developer docs, or other kinds of repositories.

I've checked that the whole doc init and doc index process still works, and moved the original prompts into the default config.

I'm not super used to typescript so I may have made some antipatterns along the way 😅

Super excited to see this tool grow further.

samheutmaker commented 1 year ago

They thanks so much for taking this on! Every looks good at first glance. I'll take a deeper look in the morning and try to get it merged tomorrow.

andrewhong5297 commented 1 year ago

They thanks so much for taking this on! Every looks good at first glance. I'll take a deeper look in the morning and try to get it merged tomorrow.

My pleasure! Thanks for open sourcing this :)

andrewhong5297 commented 1 year ago

I'm adding a filter for not including /blob/master/ in links if the user doesn't want to, since I want to direct users to the hosted docs site instead of the github! give me a sec

andrewhong5297 commented 1 year ago

kk done