Add Quarto-based documentation site for physics serialization formats#1
Draft
mmikhasenko with Copilot wants to merge 3 commits into
Draft
Add Quarto-based documentation site for physics serialization formats#1mmikhasenko with Copilot wants to merge 3 commits into
mmikhasenko with Copilot wants to merge 3 commits into
Conversation
Co-authored-by: mmikhasenko <22725744+mmikhasenko@users.noreply.github.com>
Co-authored-by: mmikhasenko <22725744+mmikhasenko@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add Markdown collection for hyperlinked HTML pages
Add Quarto-based documentation site for physics serialization formats
Oct 20, 2025
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.
This PR implements a comprehensive documentation website that gathers links and resources on serialization formats and domain-specific languages (DSLs) used across multiple physics domains.
Overview
The repository now contains a collection of Markdown documents that are automatically converted to hyperlinked HTML pages using Quarto. The site is built and deployed via GitHub Actions to GitHub Pages.
What's Included
Domain-Specific Documentation (7 pages, ~7,600 words total)
Each page provides detailed information about data formats, software frameworks, and DSLs specific to that physics domain:
General Resources
Technical Implementation
Files Added
_quarto.yml- Quarto project configurationindex.qmd- Landing page*-physics.qmd- Seven domain-specific pagesserialization-formats.qmd- General overviewstyles.css- Custom styling.github/workflows/publish.yml- CI/CD workflowCONTRIBUTING.md- Contribution guidelines.gitignore- Build artifact exclusionAfter Merging
Once merged to
main, the site will be automatically built and deployed. The live site will be available at:https://democratizing-models-project.github.io/Format-Landscape/
Note: Ensure GitHub Pages is enabled in repository Settings (Settings → Pages → Source: GitHub Actions).
Contributing
The documentation can be easily extended by editing the
.qmdfiles. SeeCONTRIBUTING.mdfor detailed guidelines on adding new formats, domains, or improving existing content.Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.