resolves 297: enhance documentation with modern page card support #298
Conversation
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
Member
prudhomm
commented
Sep 2, 2025
prudhomm
commented
- closes Enhance Documentation with Modern Page Card Support #297
- Introduced a new geometry file `mystokes.geo` for mesh generation. - Created navigation documentation for programming with Feel++. - Added detailed output directories documentation to guide users on file locations. - Established a section for setting up the Feel++ environment with examples. - Included instructions for loading meshes and using expressions in computations. - Documented the process of evaluating functions and visualizing results over a mesh. - Added explanations for defining function spaces and computing integrals. - Provided guidance on using backends for solving linear systems. - Included a comprehensive example for solving a partial differential equation. - Defined a model structure and its components for various physical problems. - Added debugging and profiling sections to assist developers. - Encapsulated Feel++ models in FMUs for interoperability. - Created a GitHub page for Feel++ with author information and pending documentation. - Compiled all tutorial pages into a cohesive developer manual for easy navigation.
- Added a new page for installation instructions from containers. - Created a dedicated page for obtaining Feel++ with detailed instructions for various platforms including Ubuntu, Debian, Windows, Spack, Docker, and Apptainer. - Updated the index page to link to the new installation instructions. - Improved Docker usage documentation with a quick start guide. - Enhanced mathematical expressions documentation with usage instructions. - Organized tool and toolbox documentation with new pages for each toolbox, including Coefficient Form PDEs, Fluid, Solid, Heat, and more. - Added illustrations and tags for better categorization and navigation in the documentation. Enhance Documentation with Modern Page Card Support Fixes #297
- Updated Antora CLI and related dependencies in package.json to latest versions. - Added numpy to requirements.txt and included a specific wheel file for feelpp_project. - Commented out unnecessary GitHub repository URLs in site-dev.yml to clean up the configuration. - Updated the UI bundle URL in site-dev.yml to a local path for easier access during development. - Set the feelpp-version to '0.110' in site.yml for version tracking. #297
prudhomm
added
the
type:feature
✅ Deploy Preview for book-feelpp-adoring-edison-f92f3c ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR resolves issue #297 by enhancing documentation structure with modern page card support across Feel++ manuals. The update reorganizes documentation into a hierarchical card-based system while upgrading dependencies and improving build configuration.
Key changes:
- Transforms documentation structure from linear to hierarchical page card navigation
- Updates Antora UI bundle from latest to specific version (v0.45-rc.4) for modern card features
- Upgrades build dependencies (@antora/cli, @antora/collector-extension, @feelpp/asciidoctor-extensions)
Reviewed Changes
Copilot reviewed 149 out of 185 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| site.yml, site-dev.yml | Update UI bundle URL to specific version and add feelpp-version parameter |
| package.json | Upgrade Antora dependencies and add cache directory for builds |
| docs/user/modules/using/pages/*.adoc | Add page metadata for card-based navigation and parent catalogs |
| docs/user/modules/install/pages/*.adoc | Restructure install documentation with page cards and split content |
| docs/user/modules/ROOT/pages/index.adoc | Transform root page to card catalog layout |
| docs/math/modules//pages/.adoc | Add hierarchical page metadata across math documentation modules |
| docs/dev/modules/tutorial/pages/index.adoc | Create comprehensive tutorial manual with card navigation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Comment on lines
+7
to
+8
| å | ||
|
|
There was a problem hiding this comment.
Line 7 contains an invalid character 'å' that appears to be a typo or encoding error. This should be removed."
Suggested change
| å |
Comment on lines
+8
to
10
| :page-cards-order: 3 | ||
| ] | ||
| PCBDDC (Balancing Domain Decomposition by Constraints) is a robust domain decomposition technique for solving large linear systems that arise, for example, from finite element discretizations of PDEs. In PETSc (and thus in {feelpp}), you can enable it via: |
There was a problem hiding this comment.
Line 9 contains a stray closing bracket ']' that should be removed. This appears to be a formatting error."
vincentchabannes
approved these changes
Sep 4, 2025
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.