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

add documentation pages #19

Closed
11 tasks done
funkchaser opened this issue Apr 25, 2024 · 1 comment · Fixed by #27
Closed
11 tasks done

add documentation pages #19

funkchaser opened this issue Apr 25, 2024 · 1 comment · Fixed by #27
Assignees
@gonzalocasas @funkchaser
Labels
documentation Improvements or additions to documentation
Milestone
Beta release

Comments

@funkchaser
Copy link
Collaborator

funkchaser commented Apr 25, 2024 •
edited by gonzalocasas
Loading

Documentation structure:

  • Introduction - a few sentences, mention aixd
  • Installation guide
  • Tutorial: workflow, components
  • Examples --> link to example files
  • Documentation of gh components (instead of API section)
  • License
  • Authors

Other tasks:
@funkchaser funkchaser added the documentation Improvements or additions to documentation label Apr 25, 2024
@gonzalocasas
Copy link
Member

Yes, or we can also publish to a subfolder of aixd.ethz.ch, both options work

funkchaser added a commit that referenced this issue Apr 29, 2024
@funkchaser
#19 add auto-generated documentation, wip
02baa19
@funkchaser funkchaser added this to the Beta release milestone Apr 29, 2024
funkchaser added a commit that referenced this issue Apr 29, 2024
@funkchaser
#19 fixed images
ccf6625
funkchaser added a commit that referenced this issue Apr 29, 2024
@funkchaser
#19 intro&tutorial wip
48769ce
funkchaser added a commit that referenced this issue Apr 29, 2024
@funkchaser
#19 customize style wip
cfbfd8b
funkchaser added a commit that referenced this issue Apr 29, 2024
@funkchaser
#19 tutorial text ok, maybe add screenshots of components
2d1b8ae
funkchaser added a commit that referenced this issue Apr 29, 2024
@funkchaser
#19 style overrides ok
1d04d2b
funkchaser added a commit that referenced this issue Apr 29, 2024
@funkchaser
#19 intro page ok
d13944b
funkchaser added a commit that referenced this issue Apr 29, 2024
@funkchaser
#19 authors and citing
db9c7ca
funkchaser added a commit that referenced this issue Apr 29, 2024
@funkchaser
#19 examples dummy
b9e4420
funkchaser added a commit that referenced this issue Apr 29, 2024
@funkchaser
#19 fixed project title, favicon
e7b7a08
funkchaser added a commit that referenced this issue Apr 29, 2024
@funkchaser
#19 more cleanup and formatting
a569a15
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 add auto-generated documentation, wip
0b79a61
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 fixed images
44222e8
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 intro&tutorial wip
97f00b7
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 customize style wip
185df35
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 tutorial text ok, maybe add screenshots of components
17aa87c
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 style overrides ok
6b85161
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 intro page ok
62022fb
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 authors and citing
51fddf6
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 examples dummy
e94e196
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 fixed project title, favicon
b4fc345
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 more cleanup and formatting
356cd70
@funkchaser funkchaser mentioned this issue May 1, 2024
Merged
@funkchaser funkchaser linked a pull request May 1, 2024 that will close this issue
19 add documentation pages #27
Merged
funkchaser added a commit that referenced this issue May 1, 2024
@funkchaser
#19 add script to generate docs from ghcomp
6ab6e18
@funkchaser funkchaser reopened this May 1, 2024
@funkchaser funkchaser mentioned this issue May 1, 2024
Closed
5 tasks
@funkchaser funkchaser reopened this May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gonzalocasas gonzalocasas

@funkchaser funkchaser

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Beta release
Development

Successfully merging a pull request may close this issue.

19 add documentation pages gramaziokohler/aixd_ara
2 participants
@gonzalocasas @funkchaser