Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This directory contains the documentation for the `base` project.
- **[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.
- **[Use Case: A Publishing Platform](./use-case-publishing.md)**: A detailed guide on using this repository as a platform to create and publish your own 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.
Expand Down
2 changes: 1 addition & 1 deletion docs/base.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The development of this template is guided by a few core principles:

1. **Code-Independent:** The template should not be tied to a specific programming language. The goal is to provide a solid foundation of repository structure, CI/CD, and best practices that can be adapted to any language or framework.

2. **Well-Documented:** Every component, workflow, and configuration file is documented in the `docs` directory. The goal is to make the repository easy to understand and modify.
2. **Well-Documented:** Every component, workflow, and configuration file is documented in the [`docs`](./) directory. The goal is to make the repository easy to understand and modify.

3. **Guidance Over Prescription:** The template provides sensible defaults and placeholder files that guide the user on how to create their own project-specific content, such as contributing guidelines or a license.

Expand Down
10 changes: 5 additions & 5 deletions docs/github-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ Before the workflow can deploy your site, you must configure your repository to
2. **Select Pages:** In the left-hand sidebar, click on **Pages**.
3. **Set the Deployment Source:** Under the "Build and deployment" section, you will see a **Source** option. Select **"GitHub Actions"** from the dropdown menu.

After you select "GitHub Actions", the UI may present you with suggestions for common workflows (e.g., "GitHub Pages Jekyll", "Static HTML"). **You can ignore these suggestions.** This repository already contains a custom, pre-configured workflow (`.github/workflows/pages.yml`) that will be used automatically.
After you select "GitHub Actions", the UI may present you with suggestions for common workflows (e.g., "GitHub Pages Jekyll", "Static HTML"). **You can ignore these suggestions.** This repository already contains a custom, pre-configured workflow ([`.github/workflows/pages.yml`](../.github/workflows/pages.yml)) that will be used automatically.

> **Note:** If you do not perform this setup step, the `pages.yml` workflow will fail with a "Get Pages site failed" or "HttpError: Not Found" error.
> **Note:** If you do not perform this setup step, the [`pages.yml`](../.github/workflows/pages.yml) workflow will fail with a "Get Pages site failed" or "HttpError: Not Found" error.

## How It Works

The site is built and deployed by the `.github/workflows/pages.yml` workflow. Here's a summary of the process:
The site is built and deployed by the [`.github/workflows/pages.yml`](../.github/workflows/pages.yml) workflow. Here's a summary of the process:

1. **Trigger:** The workflow runs automatically on every push to the `main` branch.
2. **Jekyll Build:** It uses the standard `jekyll-build-pages` GitHub Action to build a static website.
3. **Homepage:** It is configured to use the root `README.md` file as the content for the homepage (`index.html`) of the site.
4. **Styling:** The `_config.yml` file in the root of the repository specifies the `jekyll-theme-primer` theme, which gives the site the standard GitHub look and feel.
3. **Homepage:** It is configured to use the root [`README.md`](../README.md) file as the content for the homepage (`index.html`) of the site.
4. **Styling:** The [`_config.yml`](../_config.yml) file in the root of the repository specifies the `jekyll-theme-primer` theme, which gives the site the standard GitHub look and feel.
5. **Deployment:** The built static site is then deployed to GitHub Pages.

## Accessing the Site
Expand Down
4 changes: 2 additions & 2 deletions docs/licensing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Licensing Information

This repository is distributed under the MIT License, the full text of which is available in the `LICENSE` file.
This repository is distributed under the MIT License, the full text of which is available in the [`LICENSE`](../LICENSE) file.

## What is the MIT License?

Expand All @@ -10,7 +10,7 @@ The MIT License is a permissive free software license originating at the Massach

## How to Use the `LICENSE` File

The included `LICENSE` file contains a copyright line for the `base` template itself:
The included [`LICENSE`](../LICENSE) file contains a copyright line for the `base` template itself:

`Copyright (c) 2025 Attogram Project`

Expand Down
6 changes: 1 addition & 5 deletions docs/prettier.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,7 @@ pnpm add --save-dev --save-exact prettier
bun add --dev --exact prettier
```

After installing Prettier, you should create a configuration file to let editors and other tools know that you are using Prettier.

```bash
echo {} > .prettierrc
```
This repository includes a default configuration file, [`.prettierrc`](../.prettierrc), so you don't need to create one from scratch. It lets editors and other tools know that you are using Prettier.

It is also useful to create a `.prettierignore` file to specify which files should not be formatted by Prettier.

Expand Down
8 changes: 4 additions & 4 deletions docs/template-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ This allows users to generate new repositories from this one.
When adding or modifying files, remember that they will be copied verbatim into new repositories.

- **Use Placeholders:** For project-specific information like copyright notices or contact information, use clear placeholders like `[year] [fullname]` or `[INSERT CONTACT METHOD]`.
- **Write Instructional Content:** Files like `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` should not be prescriptive. Instead, they should guide the end-user on how to create their own versions of these files.
- **Write Instructional Content:** Files like [`CONTRIBUTING.md`](../CONTRIBUTING.md) and [`CODE_OF_CONDUCT.md`](../CODE_OF_CONDUCT.md) should not be prescriptive. Instead, they should guide the end-user on how to create their own versions of these files.
- **Relative Links:** Use relative links for all in-repository links (e.g., `[link text](./path/to/file.md)`) to ensure they work correctly in the generated repositories.

## Maintainer Checklist

Before tagging a new release of `base`, review the following:

- [ ] All documentation in the `docs/` directory is up-to-date with the latest changes.
- [ ] All workflows in `.github/workflows/` are tested and functioning.
- [ ] All documentation in the [`docs/`](./) directory is up-to-date with the latest changes.
- [ ] All workflows in [`.github/workflows/`](../.github/workflows/) are tested and functioning.
- [ ] All placeholder files are clear and provide good guidance.
- [ ] The `AGENTS.md` file has been updated to reflect any changes that would affect AI assistants.
- [ ] The [`AGENTS.md`](../AGENTS.md) file has been updated to reflect any changes that would affect AI assistants.
Loading