Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR implements documentation publishing automation to Jahia's Academy platform. The documentation is reformatted from standalone markdown files to the YAML frontmatter structure required by the Academy, and a GitHub Actions workflow is added to push docs on releases.
- Reformats all documentation with YAML frontmatter specifying page paths, titles, and templates
- Adds GitHub Actions workflow to automatically publish documentation on releases
- Updates internal navigation links to use relative paths instead of absolute paths
Reviewed Changes
Copilot reviewed 15 out of 16 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/README.md | Transforms main docs page to tutorials homepage with YAML frontmatter |
| docs/3-reference/README.md | Removes reference section index page |
| docs/3-reference/1-cnd-format/README.md | Adds comment to exclude incomplete content from publishing |
| docs/2-guides/README.md | Removes guides section index page |
| docs/2-guides/2-island-architecture/README.md | Adds YAML frontmatter for client-side JavaScript documentation |
| docs/2-guides/1-building-a-feedback-form/README.md | Adds YAML frontmatter and updates navigation links |
| docs/1-getting-started/README.md | Removes getting started section index page |
| docs/1-getting-started/6-building-a-nav-bar/README.md | Adds YAML frontmatter for navigation bar tutorial |
| docs/1-getting-started/5-view-content-in-full-page/README.md | Adds YAML frontmatter and fixes relative navigation link |
| docs/1-getting-started/4-making-a-blog/README.md | Adds YAML frontmatter and fixes relative navigation link |
| docs/1-getting-started/3-the-about-us-page/README.md | Adds YAML frontmatter and fixes relative navigation link |
| docs/1-getting-started/2-making-a-hero-section/README.md | Adds YAML frontmatter and fixes relative navigation link |
| docs/1-getting-started/1-dev-environment/README.md | Adds YAML frontmatter and fixes relative navigation link |
| docs/1-getting-started/0-introduction/README.md | Creates new introduction page with YAML frontmatter |
| .github/workflows/push-docs.yml | Adds GitHub Actions workflow for automated documentation publishing |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
baptistegrimaud
approved these changes
Sep 2, 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.
Description
As requested here https://github.com/Jahia/gautier-braindump/issues/37#issuecomment-3242665132, we will use the JSM repo to test the github action
This PR does that:
Checklist
Source code
Tests
Tip
Documentation to guide the reviews: How to do a code review