base

base > docs

Documentation

Guides - Development - CI/CD Workflows - Publishing - Updating - Project Management - Community - AI - Documentation Best Practices

Guides

• Software Project Guide - Using this repo as a foundation for a software project.

Development

• GitHub Codespaces - Using Codespaces for cloud-based development.
• Docker Environment - Using the included Docker setup.
• package.json Guide - Explanation of the package.json files.
• Using Prettier - Guide to installing and using Prettier.
• Prettier Workflow - Manually formatting code.

CI/CD Workflows

• CI Workflow (ci.yml) - Ensures code quality by running linting checks on every push and pull request to the main branch.
• GitHub Pages Deployment (pages.yml) - Builds and deploys the repository’s content as a GitHub Pages website.
• Prettier Workflow (prettier.yml) - Automatically formats the code in the repository using Prettier and commits the changes.
• Release on Tag (release-on-tag.yml) - Automates the creation of GitHub Releases when a new version tag is pushed.
• Secrets Management - Best practices for managing secrets in GitHub Actions.
• Workflow Scheduling - Automating recurring tasks with cron.

Publishing

• Publishing with Markdown - The simplest way to get started with publishing content.
• Advanced Publishing with HTML - For those who need more control over their site’s layout and appearance.
• Publishing with Magic Links - A powerful feature for community-driven sites.
• GitHub Pages - More detail on how the underlying GitHub Pages service works.

Updating

• Adding base to an Existing Repo - How to merge base into a project that was not created from the template.
• Syncing When base is Updated - How to get the latest changes from base after you have already merged it.

Project Management

• Repository Badges - How to use and create repository badges.
• Launch Checklist - A reusable checklist for project launches.
• Licensing Info - Details on the MIT License.
• Security Best Practices - Basic security practices for maintainers.
• Standard Files - Explanation of standard repo files.
• Template Repo Guide - Best practices for maintaining this template.
• Versioning Guide - Professional release management.

Community

• Community Building Guide - Fostering a healthy and effective community.
• Using GitHub Discussions - Leveraging Discussions for community conversations.
• Issue Management Guide - Best practices for triaging issues.

AI

• Guiding AI with AGENTS.md - Using AGENTS.md to provide instructions to AI agents.
• Prompting AI Agents - How to effectively prompt AI agents.

Documentation Best Practices

• Documentation Best Practices - How to write clear and effective documentation.

This site is open source. Improve this page.