Component refactoring, LBE, DMP #493
Conversation
… lab, and lead by example sections
…nd improve output format
…t in article counting script
… and links in lbe.json
… and links in lbe.json
…hered and biofouled polymers in lbe.json
…ling in data life cycle document
…ndling in role documents
…ge handling in data documentation
…ing in data publishing document
…ling in best practices document
…ge handling in PID documentation
…e handling in ELN documentation
…sage and add custom components guide
There was a problem hiding this comment.
Pull request overview
This pull request refactors the documentation site's component architecture by replacing legacy button/feature components with a standardized, modular system, and adds 10 new "Lead by Example" dataset entries showcasing FAIR data practices in chemistry.
Changes:
- Standardized feature/button components across the site with new
Features,FeatureButton, andButtonContainercomponents - Added 10 new Lead by Example dataset entries (including FAIR4Chem Award winners from 2022-2025)
- Created configuration files (
domains.js,roles.js,stakeholders.js) for data-driven feature rendering - Introduced
FloatImagecomponent to replace direct<img>tags anduseBaseUrlcalls - Centralized
LbeChipcomponent in commons directory - Added documentation for custom components and DMP buttons
Reviewed changes
Copilot reviewed 42 out of 44 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| static/assets/lbe.json | Added 10 new dataset entries with metadata for publications, repositories, and descriptions |
| src/pages/index.js | Replaced N4CFeatures with Features component using inline feature array |
| src/components/features/* | New standardized feature component system (Features, FeatureButton, ButtonContainer) |
| src/components/commons/* | Added FloatImage and relocated LbeChip; updated BulletBox styling |
| src/css/*.module.css | New CSS modules for Features and BulletBox components |
| docs/*/domains.js, roles.js | Externalized domain and role configuration data |
| docs/**/*.mdx | Updated imports and component usage across 20+ documentation files |
| readme/custom.md | New documentation for custom components (FloatImage, LbeChip, BulletBox) |
| scripts/articleCount.sh | New utility script for counting articles and generating TOC |
| README.md | Added custom components documentation link and reorganized structure |
Comments suppressed due to low confidence (1)
docs/50_data_publication/70_publishing_standards/28_publishing_standards_intro.mdx:1
- Corrected formatting inconsistency in horizontal rule separator.
---
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "linkcomment": "curated by the publishing authors", | ||
| "description": "The publication deals with genome mining and heterologous biosynthesis experiments in Aspergillus oryzae, elucidating the biosynthetic pathway of allantofuranone and related compounds. The dataset, curated by the authors, published in Chemotion Repository includes analytical data of natural products and pathway intermediates obtained through biosynthetic reconstitution and precursor-directed mutasynthesis, demonstrating the production of hydroxylated analogues including the new natural products deoxyascocorynin, hydroxyterferol, and hydroxyallantofuranone.", | ||
| "subdiscipline": ["organic chemistry", "natural products chemistry"], |
There was a problem hiding this comment.
The last entry in lbe.json (line 1078) is missing the tags field while all other entries include it. This inconsistency could cause issues with filtering or display logic. Add a tags array to maintain schema consistency.
| #!/bin/bash | ||
|
|
||
| # This script counts the number of articles (MD or MDX files) in the 'docs' directory | ||
| # and assembles a table of contents with their titles, slugs, and number of words. | ||
|
|
||
| DOCS_DIR="../docs" | ||
| OUTPUT_FILE="article_count.md" | ||
|
|
||
| echo "# Article Count" > $OUTPUT_FILE | ||
| echo "" >> $OUTPUT_FILE | ||
| echo "| Title | Slug | MD/MDX file path |Word Count |" >> $OUTPUT_FILE | ||
| echo "|-------|------|------------|" >> $OUTPUT_FILE |
There was a problem hiding this comment.
The table header at line 12 has 4 columns but the separator at line 13 only defines 3 columns (missing one pipe). This will break Markdown table rendering. Change line 13 to: echo \"|-------|------|------------|-----------|\" >> $OUTPUT_FILE
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
1 participant
Contains a major number of changes:
This pull request refactors and improves the documentation site by standardizing feature/button components, simplifying imports, and introducing configuration files for domain and role features. The main goals are to make the codebase more maintainable, modular, and consistent, especially regarding how features are displayed and how images are handled across documentation pages.
Component and Import Refactoring:
Replaced the use of deprecated or custom components (such as
IntroButtonandN4CFeatures) with new, standardizedFeatureButtonandFeaturescomponents throughout documentation files, improving consistency and maintainability.Introduced new configuration files
domains.jsandroles.jsthat export arrays of domain and role objects (with translation support), allowing theFeaturescomponent to render feature lists in a data-driven way. This improves scalability and localization.Standardized image handling by replacing direct
<img>tags anduseBaseUrlwith a newFloatImagecomponent, ensuring uniform styling and easier updates.Documentation and Navigation Improvements:
README.mdto add badges for localization status and workflow, and reorganized the documentation links for clarity. Also added a link to documentation about custom components.Component Import Path Updates:
LbeChipacross multiple domain documentation files to use a new, centralized location, further standardizing component usage.Lead by Example
DMP