Skip to content

Conversation

@KristopherKubicki
Copy link
Member

No description provided.

…adges-to-readme

Add CI with Codecov badges
Signed-off-by: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com>
Signed-off-by: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com>
Replace dummy module with MkDocs build test
Signed-off-by: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 22, 2025 17:04
@codecov
Copy link

codecov bot commented Jun 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR initializes the public MkDocs site for OpenBrand, adds CI badges and workflows, and ensures the site builds successfully.

  • Add mkdocs.yml, documentation pages in docs/, and link to the main README
  • Introduce a visibility badge and CI/codecov badges in README files
  • Configure GitHub Actions CI with a test for building the MkDocs site

Reviewed Changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
File Description
visibility.json Adds a public visibility badge configuration
tests/test_mkdocs.py Tests that the MkDocs site builds without error
profile/README.md Inserts CI and codecov badges and a link to main README
mkdocs.yml Configures site name, navigation, and docs dir
docs/profile.md Creates a profile documentation page
docs/index.md Creates the home documentation page
README.md Updates root README with badges and MkDocs info
.github/workflows/ci.yml Defines CI workflow including tests and coverage
Comments suppressed due to low confidence (4)

README.md:18

  • [nitpick] Add a note about installing MkDocs (for example, pip install mkdocs) before running the build or test commands to guide new contributors.
```bash

.github/workflows/ci.yml:28

  • If MkDocs isn't already in requirements.txt, consider adding a dedicated step to install MkDocs so that the mkdocs build test step has its dependency satisfied.
          pip install -r requirements.txt

mkdocs.yml:5

  • [nitpick] Since docs_dir: docs is the default for MkDocs, you could remove this line to simplify the configuration.
docs_dir: docs

tests/test_mkdocs.py:9

  • Ensure that mkdocs is listed in requirements.txt or otherwise installed in the CI environment so that this test won't fail due to a missing command.
        "mkdocs",

@KristopherKubicki KristopherKubicki merged commit 7e1d07d into main Jun 22, 2025
3 checks passed
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.

3 participants