|
|
|
|
|
|
by enono
1188 days ago
|
|
|
This looks really cool. I have a couple of questions 1. How exactly does this automatically keep docs up to date? 2. Does sidekick work well across multiple repos? (my org builds client facing apps so we have about 30 repos) 3. Is the doc auto updating expected to be in a particular format? My docs are very disorganized throughout all of these projects since I inherited a lot of codebases. Overall looks really interesting. If you can actually deliver on the use cases you describe I think this will have value to a lot of people |
|
|
1. If someone reacts to a message in Slack with the :memo: emoji, Sidekick will take the contents of the message and search for a chunk in the docs that closely matches the content. Each chunk is tagged with the source url on Github. Then it uses Github's Octokit client to pull that file, parses out appropriate chunk, and use GPT3 to merge the old content with the information from the message. Finally, it'll submit a pull request to the repo where the docs are stored with the changes.
2. Yep! It can ingest docs from multiple repos and link out to docs across all of them depending on which is most relevant. You can also add custom logic e.g. restricting it to search through certain repos for specific channels
3. It works better if there's a consistent structure throughout the docs, but it will try its best to merge info into docs that aren't structured. The risk here is that if you let Sidekick go wild it'll lead to very haphazard looking docs, so some curation is still needed.