Skip to content

[CHORE]: compodoc set up and readme update#82

Merged
chelsea-EYDS merged 1 commit intomainfrom
compodoc
Apr 5, 2023
Merged

[CHORE]: compodoc set up and readme update#82
chelsea-EYDS merged 1 commit intomainfrom
compodoc

Conversation

@chelsea-EYDS
Copy link
Contributor

CHORE

Objective:

  • Set up compodoc to run from the local apps/backend docker container by running make dev-docs (after running make build)
  • Uses tags throughout the application with the following format:
/**
* @example
*/

TODO update tags and include additional readme.md's

@chelsea-EYDS chelsea-EYDS requested a review from vyasworks April 4, 2023 20:33
Copy link
Contributor

@vyasworks vyasworks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Something to start with for code docs

@chelsea-EYDS chelsea-EYDS merged commit 0dadff5 into main Apr 5, 2023
@chelsea-EYDS chelsea-EYDS deleted the compodoc branch April 5, 2023 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants