techdocs icon indicating copy to clipboard operation
techdocs copied to clipboard

Published 20 hours ago • verified publisher icon accordproject

ADR for custom bot for Concerto

Open Kavisha4 opened this issue 11 months ago • 4 comments

Signed-off-by: Kavisha4 [email protected] custom bot is integrated for Concerto Model

Closes

This is to propose the idea 2, so anyone who reads the code architecture and documentation should be aware of the change

Changes

  • What is an ADR?

  • An architectural decision record (ADR) is a document that describes a choice the team makes about a significant aspect of the software architecture they're planning to build. Each ADR describes the architectural decision, its context, and its consequences. ADRs have states and therefore follow a lifecycle.

  • I have proposed an ADR for the issue 2 in GSoC 2024 list : Ideas List

Flags

  • Code doesn't break
  • Simple markdown file

Screenshots or Video

Related Issues

  • Issue #433
  • Pull Request #<NUMBER>

Author Checklist

  • [x] Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
  • [x] Vital features and changes captured in unit and/or integration tests
  • [x] Commits messages follow AP format
  • [ ] Extend the documentation, if necessary
  • [ ] Merging to master from fork:branchname
  • [ ] Manual accessibility test performed
    • [ ] Keyboard-only access, including forms
    • [ ] Contrast at least WCAG Level A
    • [ ] Appropriate labels, alt text, and instructions

Kavisha4 avatar Mar 25 '24 12:03 Kavisha4

Hi @Kavisha4 I'm a unsure if this doc should reside in techdocs/docs. Can you please elaborate on why do you wish this doc at that location?

sanketshevkar avatar Mar 28 '24 05:03 sanketshevkar

Hi @Kavisha4 I'm a unsure if this doc should reside in techdocs/docs. Can you please elaborate on why do you wish this doc at that location?

Hi @sanketshevkar I want to work on "Model Creation AI Assistant (Co-Pilot)" which uses the concerto repository.

Reasons why I have added it here

  1. An ADR essentially tells us which path we decided to follow at cross roads and why. In this case, as I will be highlighting in my proposal as well, its better to integrate chatbots from Dialogflow or Bard, than train an ML model in python from scratch.
  2. Since this is an ADR which tells us about the document, architecture and design of our project
  3. It seemed like an apt repository where decisions were getting documented, although I could also add this markdown file as a part of the Accord repository by creating a new "Docs"-> "Architecture"-> "Design"->"ADR for custom chat bot"

Kavisha4 avatar Mar 28 '24 08:03 Kavisha4

@Kavisha4 we'd like to add documentation to tech-docs once the product is ready. If you'd like to discuss design, feel free to create an issue in concerto repo.

sanketshevkar avatar Apr 01 '24 06:04 sanketshevkar

@Kavisha4 we'd like to add documentation to tech-docs once the product is ready. If you'd like to discuss design, feel free to create an issue in concerto repo.

Sure @sanketshevkar, will add this in my proposal, I have sent you my proposal on discord for feedback

Kavisha4 avatar Apr 02 '24 10:04 Kavisha4