NoxOrg / Nox

Source generator for Nox solutions
MIT License
6 stars 4 forks source link

[Nox.Generators] Generate Documentation for Entity Events #768

Closed rochar closed 1 year ago

rochar commented 1 year ago

Prepare templates and markdown files

  1. in .nox\docs generate a \<EntityName>EndPoints.md file for each entity (except owned entities) , that will be used to document all End Points (Use scriban)
  2. the current readme file can me moved/generated in .nox\docs (example https://github.com/NoxOrg/Nox.Generator/blob/main/samples/README.md)
  3. Update the current generated readme, add a link to each entity, for example:

Image


Generate the content for the End Points

  1. Create a Section for Entity, a section for Owned Relations,section for Relations a section for Custom Commands a section for Custom Queries
  2. All with subsection for each verb Get/Post/..
  3. Generate a summary a a relative path for each end point
gjorgji-grgovski-authoritypartners commented 1 year ago

Hi @Mornevanzyl , can you please help define the Markdown for the Readme.md documentation for the Domain Events?

This is my suggestion, but let me know if you see it differently.

`# Domain Events

This document provides information about the Domain Events in our application.

Events

WorkplaceCreated

WorkplaceUpdated

WorkplaceDeleted