Conversation
Co-authored-by: rafnixg <10915285+rafnixg@users.noreply.github.com>
Co-authored-by: rafnixg <10915285+rafnixg@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Modificar los workflows para que se genere la documentacion.
Add GitHub Actions workflow for automatic documentation generation and deployment
Aug 22, 2025
rafnixg
approved these changes
Aug 22, 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 automatic documentation generation and deployment using GitHub Actions and MkDocs, addressing the requirement to "modificar los workflows para que se genere la documentacion" (modify workflows to generate documentation).
Changes Made
Added
.github/workflows/docs.ymlthat automatically:mkdocs.ymlconfiguration and documentation in/docs/index.mdWorkflow Features
actions/checkout@v4actions/setup-python@v5actions/configure-pages@v5actions/upload-pages-artifact@v4actions/deploy-pages@v4Technical Details
The workflow consists of two jobs:
The implementation leverages the existing MkDocs setup already present in the repository, requiring no changes to documentation content or configuration files.
Testing
Once merged, documentation will be automatically available at https://rafnixg.github.io/bcv-api/ and will update automatically with future changes.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.