An open API service indexing awesome lists of open source software.

https://github.com/denisecase/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.
https://github.com/denisecase/applied-computing-foundations

computer-science-education computing-foundations education git mkdocs

Last synced: 20 days ago
JSON representation

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.

Awesome Lists containing this project

README

          

# Applied Computing Foundations

[![Docs](https://github.com/denisecase/applied-computing-foundations/actions/workflows/deploy-zensical.yml/badge.svg?branch=main)](https://denisecase.github.io/applied-computing-foundations/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/MIT)
![CI Status](https://github.com/denisecase/applied-computing-foundations/actions/workflows/ci-hygiene-zensical.yml/badge.svg?branch=main)
[![Check Links](https://github.com/denisecase/applied-computing-foundations/actions/workflows/links.yml/badge.svg?branch=main)](https://github.com/denisecase/applied-computing-foundations/actions/workflows/links.yml)
[![Dependabot](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg)](https://github.com/denisecase/applied-computing-foundations/security)

> 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 .

## Requirements

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

## To Host an Zensical 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:

```shell
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
# repeat if changes were made
git add -A
uvx pre-commit run --all-files
```

```shell
uv run zensical build
```

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):

```shell
git add -A
git commit -m "your message here"
git push -u origin main
```

## Resources

[GUIDE: Pro Analytics 02](https://denisecase.github.io/pro-analytics-02/) - Professional Python project starter and guide using uv, Ruff, zensical, and GitHub Actions

## Annotations

[ANNOTATIONS.md](./ANNOTATIONS.md)

## Citation

[CITATION.cff](./CITATION.cff)

## License

[MIT](./LICENSE)

## SE Manifest

[SE_MANIFEST.md](./SE_MANIFEST.toml)