Open
Conversation
Contributor
|
Great job:
|
Member
Author
|
In this PR here I split the files kinda arbitrary, could probably make larger blocks and/or separate better what is specific to this ab example and what could be used in others and such. But yeah, the advantage is that the sections are re-usable but indeed it changes the way you write them |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I started working on changing the antibody-antigen tutorial to add sections for the web service and I noticed that you have ALL the information in a single 3.000 lines file.
This website uses a very powerful jekyll templating engine that I think could be utilized to help organize the tutorials.
So in this PR I re-organized it to demonstrate what is possible in terms of reusable sections
Concept
Instead of having ALL the sections into one single file, you can divide them into separate files, for example:
Then when you are creating a given tutorial, you do not need to copy-paste anything, you simply re-use the sections.
This tutorial consists of the following sections: {:toc} <hr /> {% include_relative sections/ab/intro.md %} {% include_relative sections/general/haddock-concepts.md %} {% include_relative sections/general/intro-to-haddock3.md %} {% include_relative sections/ab/preparing-antigen.md %} {% include_relative sections/ab/preparing-antibody.md %} {% etc %} ## You can still write specific stuff hereBenefits
touching the core content
index.mdbecomes a clear table of contents which is easy to see the tutorial structure at a glanceDrawbacks
Needless to say nothing changes from the user side and the page is rendered exactly the same.
Please have a look at the file structure and let me know if you want to move forward with this re-usable section approach.
For example, this is how the antibody-antigen tutorial
index.mdwould look like:{% include_relative sections/intro.md %} {% include_relative sections/prompt-legend.md %} {% include_relative sections/haddock-concepts.md %} {% include_relative sections/haddock3-intro.md %} {% include_relative sections/setup-intro.md %} {% include_relative sections/setup-ljubljana-2026.md %} {% include_relative sections/setup-kobe-2026.md %} {% include_relative sections/setup-pula-2025.md %} {% include_relative sections/setup-local.md %} {% include_relative sections/preparing-pdb-intro.md %} {% include_relative sections/preparing-antibody.md %} {% include_relative sections/preparing-antigen.md %} {% include_relative sections/restraints-intro.md %} {% include_relative sections/restraints-paratope.md %} {% include_relative sections/restraints-epitope.md %} {% include_relative sections/restraints-ambiguous.md %} {% include_relative sections/restraints-validation.md %} {% include_relative sections/restraints-multichain.md %} {% include_relative sections/docking-intro.md %} {% include_relative sections/docking-workflow.md %} {% include_relative sections/run-haddock3-intro.md %} {% include_relative sections/run-bioexcel2025.md %} {% include_relative sections/run-discoverer.md %} {% include_relative sections/run-truba.md %} {% include_relative sections/run-fugaku.md %} {% include_relative sections/run-ljubljana-2026.md %} {% include_relative sections/haddock3-execution-modes.md %} {% include_relative sections/analysis-intro.md %} {% include_relative sections/analysis-clusters.md %} {% include_relative sections/analysis-scores.md %} {% include_relative sections/analysis-single-structure.md %} {% include_relative sections/analysis-contacts.md %} {% include_relative sections/analysis-visualization.md %} {% include_relative sections/conclusions.md %} {% include_relative sections/bonus1-mutations.md %} {% include_relative sections/bonus2-arctic3d.md %} {% include_relative sections/bonus3-ai-models.md %} {% include_relative sections/bonus4-ensemble.md %} {% include_relative sections/bonus5-alphafold2.md %} {% include_relative sections/bonus6-scoring.md %} {% include_relative sections/congratulations.md %}