search

michaelcychan-org / medapp-example

0 stars 1 forks source link

Coauthor Setup #2

Closed michaelcychan closed 5 months ago

michaelcychan commented 5 months ago

Coauthor Setup

This is a pull request created by Coauthor.

Coauthor generates documentation for you based on the config file. You can always change the Config File and a new set of documentations will be automatically generated, you will be able to preview them in the corresponding Pull Request.

Coauthor is going to generate a new set of documentations for you when there is any change in .coauthor/ directory.
You can place your custom markdown documents in .coauthor/ directory and you can easily access them from Coauthor.

It takes a few minutes for Coauthor to generate the documentation. When everything is ready, Coauthor will create a comment in the Pull Request, you will be able to use the link in the comment to access the documentation.
If there is anything wrong with the config file, the comment will also contain the error message.

Please also apply the necessary branch protection rules to include the Pull Request Checks run by Coauthor.

dev-coauthor-m[bot] commented 5 months ago

Changes have been made to Coauthor config file Documentation Preview Created: Documentations Overview Page

Config file Warning Messages: config.yaml: Please use a valid GitHub Project Link at /SDLC/IssueTracking/TrackingProjectLink at line 44