-
Notifications
You must be signed in to change notification settings - Fork 0
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
Conversation
it will be updated
* collaborative infrastructure from both * intro linking to 'About this Guide' for more context and personalization instructions * shared logo
- 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
There was a problem hiding this 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)
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.
The updated logo was added in #50, but it seems I didn't merge |
allowing generally simplifies updates for downstream users
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍🎉 and as per online discussion.
Closes #45 and #49.