Ascribe: Your Release Notes Generator

• 

  Starter

• 

  Selecting a Project

• 

  Editing Desired Result Using TinyMCE and OpenAI Integrations

Inspiration

Generating Release Notes can be a lot of Work especially if it is geared to different audiences. What if you Can Automatically Generate Notes from Changelogs of Projects including Applications, Open Source Projects and other products.

What it does

Ascribe can be used by anyone on a team to generate release notes and a short summary for a product/software release. Simply select An Open Source Project and Automatically generates a summary and release notes where users can go from there to edit and add more.

How we built it

Built with

• Angular 17 with modern APIs such as signals, signal queries and more.
• Angular Material
• OpenAI 🚀
• TinyMCE Editor ✅
• NgxMarkdown
• NX

Challenges we ran into

• Wanted to build a custom plugin to select the projects available from a button that would be integrated into TinyMCE editor but couldn't figure out how to do that. Instead, I resolved to add a form outside the editor and have the user select the project from there.
• TinyMCE didn't offer good type inference and had to look at the documentation a lot to figure out how to craft the initial inputs

Accomplishments that we're proud of

• Having not used TinyMCE before, I was able to integrate the TinyMCE editor into a newly-generated Angular Application using the nx cli: pnpm dlx create-nx-workspace@latest release-notes-generator and then integrated TinyMCE
• Integrating OpenAI API usage into the application and have the user generate a starter doc to then edit later
• Utilizing new Angular APIs such as signals and signal queries

What we learned

• How to integrate Open AI api with TinyMCE
• Prompt Engineering to get desired responses

What's next for Ascribe: Your Release Notes Generator

• Add dynamic data to integrate into the application
• Add features like publishing and auditing

Built With

• angular.js
• nx
• openai
• tinymce