The Convention is a collection of general articles, conventions, and guides for software development as a reference to apply standardized approaches in projects.

• 1. Details
  • 1.1. Prerequisites
  • 1.2. Usage
• 2. Contribute
• 3. Troubleshoot
  • 3.1. TODO
• 4. References

• Git

  Distributed version control system for tracking source code changes.

  sudo apt install git

• Make

  Task automation tool to manage build processes and workflows.

  sudo apt install make

MkDocs is used as the static site generator for building and serving the documentation site.

1. Insights and Details

   • Navigation

     Navigation is managed by the mkdocs-awesome-nav plugin.

   • CommonMark Flavored Markdown

     A custom MkDocs hook in mkdocs_hooks.py normalizes markdown rendering behavior for CommonMark-style content and GitHub Flavored Markdown.

   • Configuration

     The mkdocs.yml file contains the configuration for the MkDocs site, including theme, plugins, and markdown extensions.

2. Usage and Instructions

   • CI/CD

     uses: .github/actions/mkdocs

   • Tasks

     make pages-mkdocs-setup

     make pages-mkdocs-build

     make pages-mkdocs-serve

CONTRIBUTING.md provides guidens and instructions for contributing to the project.

• AI Agents

  Automated tools that assist in various development tasks such as code generation, testing, and documentation.

• Skills Manager

  CLI tool for managing AI agent skills in development projects.

• Task Runner

  Make automation tool that defines and manages tasks to streamline development workflows.

• Bootstrap

  Scripts to bootstrap, setup, and teardown a software development workspace with requisites.

• Git Hooks Manager

  Lefthook automates Git hooks for pre-commit linting and commit message validation.

• Dev Containers

  Consistent development environments using Docker containers.

• Release Manager

  Semantic-Release automates the release process by analyzing commit messages.

• Update Manager

  Renovate and Dependabot automate dependency updates by creating pull requests.

• Policy Manager

  Conftest for policy-as-code enforcement.

• Supply Chain Manager

  Trivy for security scanning of vulnerabilities, misconfigurations, and compliance issues.

• Documentation Generators

  MkDocs for building and serving the documentation site.

TODO

• Sentenz Template DX repository.
• Sentenz Actions repository.
• Sentenz Skills repository.
• Sentenz Manager Tools article.