diff --git a/README.md b/README.md index 14299ab..c3339e0 100644 --- a/README.md +++ b/README.md @@ -1 +1,3 @@ Welcome to [base](./docs/base.md) + +- [Documentation](./docs/README.md) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..3ef270a --- /dev/null +++ b/docs/README.md @@ -0,0 +1,13 @@ +# Documentation + +This directory contains the documentation for the `base` project. + +- **[The `base` Philosophy](./base.md)**: An overview of the core principles and goals behind this template repository. +- **[Docker-based Development Environment](./docker.md)**: Instructions on how to use the included Docker setup for a consistent development environment. +- **[GitHub Codespaces](./github-codespaces.md)**: A guide to using GitHub Codespaces for a cloud-based development experience. +- **[GitHub Pages Site](./github-pages.md)**: Information on how the project's documentation is automatically built and deployed as a website. +- **[GitHub Workflows](./github-workflows.md)**: An explanation of the CI/CD workflows for linting, testing, and releasing. +- **[Licensing Information](./licensing.md)**: Details on the MIT License and how to properly attribute copyright. +- **[Deploying to Render.com](./render.md)**: Instructions for deploying the project to the Render.com platform. +- **[Standard Repository Files](./standard-files.md)**: An explanation of the standard configuration files like `.gitignore`, `.editorconfig`, and `.gitattributes`. +- **[Maintaining `base` as a Template Repository](./template-repo.md)**: A guide for maintainers of this template, outlining best practices and administrative steps.