Skip to content

Initial Docs Layout and Deployment - #1

Merged
TimMonko merged 4 commits into
mainfrom
repo-setup
Aug 3, 2025
Merged

Initial Docs Layout and Deployment#1
TimMonko merged 4 commits into
mainfrom
repo-setup

Conversation

@TimMonko

@TimMonko TimMonko commented Aug 3, 2025

Copy link
Copy Markdown
Owner

Initial mkdocs setup with absolutely minimal instructions for creating, serving, and deploying with Github Actions.

@TimMonko

TimMonko commented Aug 3, 2025

Copy link
Copy Markdown
Owner Author

Generated with Github Copilot:

This pull request introduces a comprehensive setup for building, testing, and deploying documentation using MkDocs with the Material theme, alongside some foundational project configurations. The changes include adding GitHub Actions workflows for automated documentation deployment, setting up MkDocs configuration files, and providing detailed documentation for setting up and managing the process.

Documentation Deployment and Workflow Setup:

  • Added a GitHub Actions workflow (.github/workflows/deploy_docs.yml) to test documentation builds on pull requests and deploy them to GitHub Pages on pushes to the main branch. The workflow ensures concurrency control and uses uv for running MkDocs commands.

Documentation and MkDocs Configuration:

  • Added mkdocs.yml to configure the MkDocs site with the Material theme and a custom site URL.
  • Created docs/index.md as the homepage for the documentation, providing an overview of MkDocs commands and project layout.
  • Added docs/docs_setup.md with detailed instructions on setting up MkDocs locally, creating and deploying documentation, and using GitHub Actions for automation.
  • Added docs/gh_repo_settings.md with recommendations for GitHub repository settings, including branch protection rules and pull request workflows.

Project Configuration:

  • Added pyproject.toml to define the project metadata and dependencies, specifying mkdocs-material as a required dependency.
  • Updated .python-version to specify Python 3.13 for consistency across environments.

Miscellaneous:

  • Introduced a simple main.py script with a "Hello from urssi-docs!" message, likely as a placeholder or test file.

@TimMonko TimMonko changed the title Initial Repo Layout Initial Docs Layout and Deployment Aug 3, 2025
@TimMonko
TimMonko merged commit b9308b5 into main Aug 3, 2025
1 check passed
@TimMonko
TimMonko deleted the repo-setup branch August 3, 2025 20:15
@TimMonko
TimMonko restored the repo-setup branch August 13, 2025 06:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant