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.

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

Already on GitHub? Sign in to your account

Fix and Extend Documentation for Release 2.0 #120

Open
20 of 27 tasks
Tracked by #121
cb-Hades opened this issue Apr 19, 2024 · 0 comments
Open
20 of 27 tasks
Tracked by #121

Fix and Extend Documentation for Release 2.0 #120

cb-Hades opened this issue Apr 19, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@cb-Hades
Copy link
Collaborator

cb-Hades commented Apr 19, 2024

The refineGEMs documentation needs to be extended and adjusted to fit the changes from the restructuring and extension for the new release 2.0.

Notes[^1]:

  • 馃煝 fix all broken links & Co
    • 馃煝 inside rst files
  • 馃煝 adjust all code docs to fit the new standard
  • 馃煚 re-check polish and gap fill descriptions -> @GwennyGit
  • usage
    • 馃煚 usage-how to use specific functionalities: keep or refer to 'about different applications'?
    • 馃數 media access
  • 馃煝 page for the media config + explanations on how to use it?
  • growth
    • 馃煚 re-check growth desc. for completeness
    • 馃煟 add more example plots to growth -> which data?
  • 馃數 do we want more desc. pages e.g. for egcs, stats analysis and more?
    • 馃煝 EGCs
    • 馃煝 statistical
  • media database & co
    • 馃敶 Media database descriptions under "Working with the Data" are a mess
      • 馃煝 architecture should be fixe
      • 馃煝 available media
      • 馃煝 available subsets
      • 馃數/ 馃敶 lab->in silico
  • 馃煝 link the actual code anywhere like is in remote and COBRApy
  • 馃煚 what to do with the pipeline? -> @GwennyGit
  • 馃數 extend help and faq
  • 馃敶 PATH_TO_DATABASE is written out based on the current PC when compiling docs - what to do?
  • 馃敶 irregular appearance of grey boxes -> ???
  • 馃數 re-write is_valid_database in rg.utility.databases to fit new DB
  • 馃煝 Intro for db.py
  • 馃煟 different colour for reference links
    • managed to find the command for the inline code but not for the python linkes
  • 馃煝 add command line options somewhere (see DIAMOND wiki)

[^1] Legend: 馃煝 done; 馃數 TODO; 馃煚 open for discussion; 馃煟 idea; 馃敶 problem; 馃煠 set to the side

@cb-Hades cb-Hades added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Apr 19, 2024
@cb-Hades cb-Hades self-assigned this Apr 19, 2024
cb-Hades added a commit that referenced this issue Apr 19, 2024
cb-Hades added a commit that referenced this issue Apr 22, 2024
cb-Hades added a commit that referenced this issue Apr 23, 2024
fixed everything that caused a warning
@GwennyGit GwennyGit self-assigned this Apr 23, 2024
cb-Hades added a commit that referenced this issue Apr 23, 2024
cb-Hades added a commit that referenced this issue Apr 23, 2024
cb-Hades added a commit that referenced this issue Apr 24, 2024
cb-Hades added a commit that referenced this issue Apr 29, 2024
cb-Hades added a commit that referenced this issue Apr 29, 2024
cb-Hades added a commit that referenced this issue Apr 30, 2024
cb-Hades added a commit that referenced this issue May 3, 2024
cb-Hades added a commit that referenced this issue May 3, 2024
cb-Hades added a commit that referenced this issue May 8, 2024
cb-Hades added a commit that referenced this issue May 24, 2024
cb-Hades added a commit that referenced this issue Jun 3, 2024
GwennyGit added a commit that referenced this issue Jun 7, 2024
GwennyGit added a commit that referenced this issue Jun 7, 2024
cb-Hades added a commit that referenced this issue Jun 7, 2024
cb-Hades added a commit that referenced this issue Jun 7, 2024
cb-Hades added a commit that referenced this issue Jun 7, 2024
cb-Hades added a commit that referenced this issue Jun 7, 2024
cb-Hades added a commit that referenced this issue Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants