-
Notifications
You must be signed in to change notification settings - Fork 0
Clean Up Public Site 🌲 #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…adges-to-readme Add CI with Codecov badges
Signed-off-by: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com>
…-readme-badges Fix CI and badges
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>
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
There was a problem hiding this 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 indocs/, 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 themkdocs buildtest step has its dependency satisfied.
pip install -r requirements.txt
mkdocs.yml:5
- [nitpick] Since
docs_dir: docsis the default for MkDocs, you could remove this line to simplify the configuration.
docs_dir: docs
tests/test_mkdocs.py:9
- Ensure that
mkdocsis listed inrequirements.txtor otherwise installed in the CI environment so that this test won't fail due to a missing command.
"mkdocs",
No description provided.