Skip to content

Update template site homepage #52

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from
Open

Update template site homepage #52

wants to merge 6 commits into from

Conversation

egrace479
Copy link
Member

  • Adds the updated Collaborative Infrastructure Diagram (Update Collaborative Infrastructure Diagram #49).
  • Refocuses the Imageomics-specific parts to be Imageomics and ABC.
  • Adds link to About the Guide Section of the README for personalization and interaction instructions.

Closes #45 and #49.

* collaborative infrastructure from both

* intro linking to 'About this Guide' for more context and personalization instructions

* shared logo
@egrace479 egrace479 added this to the Generalize Guide milestone Jun 30, 2025
@egrace479 egrace479 requested review from hlapp and gwtaylor June 30, 2025 23:05
@egrace479 egrace479 added design UX or presentation needs attention documentation Improvements or additions to documentation labels Jun 30, 2025
gwtaylor added 3 commits July 23, 2025 18:11
- Fix typo: '<Ogranization>' → '<Organization>' in branding section
- Remove trailing punctuation from main heading (MD026)
- Add blank lines around headings (MD022)
- Add blank line around lists (MD032)
- Remove inline HTML <br> tags (MD033)
- Remove trailing whitespace (MD009)

All markdownlint rules now pass for docs/index.md
- Split dense introductory paragraph into focused sections
- Clarify scope as 'imageomics and related interdisciplinary fields'
- Move template customization info to separate, less prominent paragraph
- Change 'imageomics-related terms' to 'scientific terms' for broader consistency
- Improve readability and reduce user confusion about template vs guide usage
MkDocs build output directory should not be tracked in version control
Copy link
Collaborator

@gwtaylor gwtaylor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @egrace479,
This looks great! I've reviewed the homepage updates for the template transition and made some edits as additional commits.

Changes Made

Style & Quality Improvements

  • Fixed typo: <Ogranization><Organization> in the branding section
  • Applied markdownlint fixes: Resolved all formatting violations (heading punctuation, blank lines, inline HTML)
  • Improved content flow: Split the dense introductory paragraph for better readability
  • Enhanced clarity: Positioned scope as "imageomics and related interdisciplinary fields" and moved template meta-info to separate paragraph

Repository Maintenance

  • Added site/ to .gitignore: MkDocs build output should not be tracked

Outstanding Issue (Not Blocking)

⚠️ Missing logo file: The referenced logos/Imageomics_ABC.png doesn't exist yet. Based on issues #45 and #17, this is an ongoing design decision rather than a blocker. I actually see a version of this logo added to a comment in #17 so perhaps it is just a matter of adding it to the proper location in the repo.

The template placeholder syntax is appropriate until the logo approach is finalized.

Technical Verification

✅ All markdownlint rules pass
✅ MkDocs builds successfully
✅ Links functional
✅ No new rendering issues

The homepage updates successfully implement the joint Imageomics/ABC approach from issue #45 while maintaining the template structure for future forking.

@@ -1,30 +1,33 @@
# Welcome to the Collaborative Distributed Science Guide!
# Welcome to the Collaborative Distributed Science Guide
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the trailing “!” here to satisfy markdownlint rule MD026 (no trailing punctuation in headings). MD026 treats headings as titles rather than sentences, so ending punctuation like “!” is disallowed by default.

If you really want to keep the exclamation mark, we can either:

  1. Allow “!” in our .markdownlint.json:

    {
      "MD026": { "punctuation": ".,;:!" }
    }
  2. Disable MD026 for just this heading:

    <!-- markdownlint-disable MD026 -->
    # Welcome to the Collaborative Distributed Science Guide!
    <!-- markdownlint-enable MD026 -->

Both options preserve the “!” while keeping linting active elsewhere.

Comment on lines -67 to -70

<br>
<br>

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the two <br> tags here to satisfy markdownlint rule MD033 (no inline HTML). Relying on <br> for spacing mixes presentation into content and can render inconsistently across themes.

If it's important to maintain this space above the footer, we could inject bottom whitespace via CSS:

  1. Create a file docs/stylesheets/extra.css with something like:

    /* For Material for MkDocs */
    .md-typeset {
      padding-bottom: 2rem;
    }
    /* For default MkDocs theme */
    .content {
      padding-bottom: 2rem;
    }
  2. Enable it in the mkdocs.yml:

    extra_css:
      - stylesheets/extra.css

This keeps the Markdown clean, avoids inline HTML, and gives consistent vertical space before the footer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design UX or presentation needs attention documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants