Applied Computing Foundations

Applied computing foundations, including how to set up a place for repositories, how to view file extensions, and how to work with hidden files and folders.

See the hosted documentation at https://denisecase.github.io/applied-computing-foundations/.

Requirements

No setup is required to view or use the documentation site linked above.

To Host an MkDocs Site (Like This)

While viewing your GitHub repository in the browser, click the Settings (gear) icon.

1. Click the Pages tab.

   • Set Build and deployment / Source to GitHub Actions

2. (Optional, but required if you keep the Dependabot badge)

   • Click the Security & analysis tab
   • Enable Dependabot alerts

Developer (Updating The Documentation)

Pre-commit is optional; GitHub Actions will report issues if it fails.

Steps to run pre-commit locally (optional). First, install uv. Then, initialize once:

uv self update
uv python pin 3.14
uv sync --extra dev --extra docs --upgrade

uvx pre-commit install
git add -A
uvx pre-commit run --all-files

Build and serve docs (hit CTRL+c in the VS Code terminal to quit serving):

uv run mkdocs build --strict
uv run mkdocs serve

While editing project code and docs, repeat the commands above to run files, check them, and rebuild docs as needed.

Save progress frequently (some tools may make changes; you may need to re-run git add and commit to ensure everything gets committed before pushing):

git add -A
git commit -m "update"
git push -u origin main

Resources

GUIDE: Pro Analytics 02 - Professional Python project starter and guide using uv, Ruff, MkDocs, and GitHub Actions

Annotations

ANNOTATIONS.md

Citation

CITATION.cff

License

MIT

SE Manifest

SE_MANIFEST.md