Detail the usage of `YARD` and GitHub Pages in the generation of code documentation - Githubissues

pulibrary / rdss-handbook

Research Data and Scholarship Services Team Handbook

6 stars 0 forks source link

Detail the usage of `YARD` and GitHub Pages in the generation of code documentation #269

Open jrgriffiniii opened 2 months ago

jrgriffiniii commented 2 months ago

YARD is currently used in at least one project (please see https://github.com/pulibrary/pdc_describe/blob/main/.github/workflows/pages.yml#L32), and I would like to please propose that the handbook provide a brief outline of how this uses inline code comments to build and publish project documentation.

Acceptance Criteria:

[ ] RDSS team members will be able to identify and understand YARD comment syntax
[ ] RDSS team members will be able to implement and maintain GitHub Pages publishing workflows (using GitHub Actions)
[ ] RDSS team members will know how to generate YARD-based code documentation locally