Skip to content

Create documentation files to enable documenting AME on https://aca-py.org #211

Description

@swcurran

I think it would be helpful to have a tab on the https://aca-py.org site for AME. To do that I think we need:

  1. A top level documentation file that is the landing page for the section. It might be the README.md for this repo or a separate one that is tailored to a user landing on the page on the https://aca-py.org site. It should include an introduction to AME, why it is useful, what examples are, and how to create your own examples. If useful, those topics could be in separate MD files.
  2. A README for every example, that at minimum defines what the example does, and ideally when to use it and why it is there.

Given that, we can create a similar script to the one for the ACA-Py Plugins repo to generate the AME documentation into the https://aca-py.org site. On build, a script called from the GitHb Actions pulls in the repo, and generates a YAML table of contents of the pages to be built in.

Would like help pointing out, creating the necessary docs -- especially at least a cursory README for each example.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions