Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

General Documentation #32

Open
1 of 5 tasks
aradermacher opened this issue Feb 2, 2024 · 1 comment
Open
1 of 5 tasks

General Documentation #32

aradermacher opened this issue Feb 2, 2024 · 1 comment
Assignees
@aradermacher @YuXHe15
Labels
documentation Improvements or additions to documentation

Comments

@aradermacher
Copy link
Collaborator

aradermacher commented Feb 2, 2024 •
edited by YuXHe15
Loading

  • add some general description to the readme
  • add picture from conference paper
  • link the conference paper
  • check wiki pages
  • add a doc folder?
@aradermacher aradermacher self-assigned this Feb 2, 2024
@aradermacher aradermacher added the documentation Improvements or additions to documentation label Feb 2, 2024
@YuXHe15 YuXHe15 self-assigned this Aug 15, 2024
@YuXHe15
Copy link
Collaborator

YuXHe15 commented Aug 15, 2024 •
edited
Loading

Workflow for Documentation Development and Deployment

Benefits:

  • User-friendly editing process, requiring only Markdown.
  • Seamless integration of figures, equations, and code documentation within a single Markdown file.
  • Flexible arrangement of descriptions alongside relevant function docstrings.
  • Automated deployment and local development builds with simple commands.
image

You could give it a try at Doc of amworkflow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aradermacher aradermacher

@YuXHe15 YuXHe15

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

When branches are created from issues, their pull requests are automatically linked.

32-general-documentation BAMresearch/amworkflow
2 participants
@aradermacher @YuXHe15