12 add docs #13
Merged
12 add docs #13
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
- Add GitHub downloads badge to README for better project visibility - Create comprehensive API documentation in docs/api with setup instructions - Include examples for auto-documentation generation and module usage - Document core features, configuration, and integration patterns
…ture - Update project name from AMBD-MC to TestRepo in README.md and CONTRIBUTING.md - Add MkDocs configuration for documentation site with Material theme - Implement GitHub Actions workflow for automated documentation deployment - Add .gitignore to exclude Visual Studio Code settings
Closed
- Correct plugin name from `mkdocs-git-revision-date-localized` to `mkdocs-git-revision-date-localized-plugin` in docs workflow - Move mkdocs.yml from .github/workflows to root directory and update plugin configuration - Add _test_build/ directory to .gitignore to exclude test artifacts
- Added Node.js setup step (v18) to run markdown-link-check - Replaced lychee-action with markdown-link-check for link validation - Link check runs on all markdown files in docs directory and ignores errors - Maintains optional nature of link checking to avoid breaking CI pipeline
The documentation build step using mkdocs has been removed from the CI workflow. This change simplifies the workflow by eliminating the conditional documentation build that was triggered when a mkdocs.yml file existed.
Upload built site as artifact in build job for reuse in deploy job. Download artifact in deploy job to avoid rebuilding the site. Extend deploy job to run on push to main and PRs targeting main for previews.
Update GitHub Actions used for documentation deployment to their latest major versions: - actions/upload-pages-artifact from v1 to v4 - actions/deploy-pages from v1 to v4 This ensures compatibility with the latest GitHub Pages features and improves security and performance of the deployment workflow.
Added contents read, pages write, and id-token write permissions to enable secure deployment of documentation to GitHub Pages.
Add 'enablement: true' to the configure-pages action to explicitly enable Pages deployment in the docs workflow, ensuring the site is properly configured before uploading artifacts.
Remove the 'enablement: true' configuration from the actions/configure-pages@v4 step in the docs deployment workflow, as it is no longer required or has been deprecated in the latest action version. This simplifies the workflow and prevents potential issues.
- Change mkdocs.yml navigation to link to examples/example1.md instead of index.md for direct access to the primary example - Remove git-revision-date-localized plugin from mkdocs.yml to simplify dependencies and reduce build complexity - Simplify GitHub workflow by removing fetch-depth: 0 from checkout and uninstalling unnecessary mkdocs plugins - Add site directory check in workflow to ensure build success - Update generated site files to reflect navigation changes and remove revision date elements for cleaner output
… mkdocs build - Upgrade Python version from 3.10 to 3.11 for improved performance and features - Add --verbose flag to mkdocs build for better debugging output during deployment
Add the `path` parameter to the `actions/download-artifact` step in the documentation deployment workflow. This explicitly sets the download destination for the 'site' artifact, ensuring the artifact is placed in the expected `site` directory for subsequent deployment steps.
TkungAI
approved these changes
Jan 21, 2026
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.
name: Pull Request
about: Submit changes and request merge
Change Type
Change Description
Please briefly describe what this change does and why it is needed.
Related Issue
Fixes # (issue number)
Testing
Other Notes