mkdocs.yml

site_name: Serendipity - Dev. Guidelines

theme:
  name: material
  features:
    - instant.loading
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.instant
    - navigation.top
    - navigation.footer
    - navigation.path
    # - navigation.expand
  palette:
    primary: indigo
    accent: indigo
  font:
    text: Roboto
    code: Roboto Mono

plugins:
  - search
  - minify:
      minify_html: true
  - git-revision-date-localized:
      type: date
      exclude:
        - new-project-kit/docs-template/*
  - awesome-pages

markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
  - attr_list
  - md_in_html

extra_css:
  - assets/css/custom.css

exclude:
  - new-project-kit/docs-template/README.md

nav:
  - Home:
      - Start here: index.md
      - Starting new projects: new-project-kit/setup-guide/step0.md
  - New Project Kit:
      - Start a new Project:
          - Start Here: new-project-kit/setup-guide/step0.md
          - Checklist: new-project-kit/setup-guide/checklist.md
          - Github Project Setup Guide: new-project-kit/github-project-setup-guide.md
      - View Templates: new-project-kit/templates_repos.md
      - Product Requirements Document (PRD):
          - Discovery and Ideation — Worksheet: new-project-kit/docs-template/docs/project-docs/discovery_and_ideation_worksheet_template.md
          - PRD Template: new-project-kit/docs-template/docs/project-docs/prd_template.md
      - Technical Design Documentation:
          - TDD Template: new-project-kit/docs-template/docs/project-docs/tdd_template.md
          - TDD Template (with examples): new-project-kit/docs-template/docs/project-docs/tdd_template_with_examples.md
  - Dev. Guidelines:
      - Start Here: dev-guidelines/index.md
      - Programming Guidelines:
          - For All Languages: dev-guidelines/coding_guidelines.md
          - Language Specific:
              - Python: dev-guidelines/coding_guidelines_python.md
              - Dart-Flutter: dev-guidelines/coding_guidelines_dart.md
              - JavaScript: dev-guidelines/coding_guidelines_js.md
              - CSS: dev-guidelines/coding_guidelines_css.md
              - React: dev-guidelines/coding_guidelines_react.md
      - Git & Git Workflows:
          - Git Best Practices: dev-guidelines/git_best_practices.md
          - Git Workflows: dev-guidelines/git_workflows.md
      - Testing Guidelines:
          - Testing Guidelines: dev-guidelines/testing_guidelines.md
          - All Testing:
              - Whitebox/Functional testing:
                  - Unit Testing: dev-guidelines/testing_guidelines_unit_testing.md
                  - Integration Testing: dev-guidelines/testing_guidelines_integration_testing.md
                  - API Testing: dev-guidelines/testing_guidelines_api_testing.md
                  - Code Coverage Testing: dev-guidelines/testing_guidelines_code_coverage_testing.md
              - Security Testing:
                  - Penetration(Security) Testing: dev-guidelines/testing_guidelines_penetration_testing.md
                  - Security Audits: dev-guidelines/testing_guidelines_security_audits.md
              - Performance Testing:
                  - Load Testing: dev-guidelines/testing_guidelines_load_testing.md
                  - Stress Testing: dev-guidelines/testing_guidelines_stress_testing.md
              - Software Testing:
                  - Regression Testing: dev-guidelines/testing_guidelines_regression_testing.md
                  - Smoke Testing: dev-guidelines/testing_guidelines_smoke_testing.md
                  - UI Interface Testing: dev-guidelines/testing_guidelines_ui_testing.md
                  - User Acceptance Testing: dev-guidelines/testing_guidelines_acceptance_testing.md
                  - Blackbox/Behavioral Testing: dev-guidelines/testing_guidelines_blackbox_testing.md
      - Continuous Integration(CI) Guidelines:
          - CI Guidelines:
              - CI Guidelines: dev-guidelines/ci_guidelines.md
              - Code linting: dev-guidelines/ci_guidelines_linting.md
              - Automated testing: dev-guidelines/ci_guidelines_testing.md
              - CI Tools: dev-guidelines/ci_guidelines_tools.md
          - CI Templates: dev-guidelines/ci_templates.md
          - Testing Checklist: dev-guidelines/testing_checklist.md
          - TDD Guidelines: dev-guidelines/tdd_guidelines.md
      - Continuous Deployment(CD) Guidelines:
          - CD Guidelines: dev-guidelines/cd_guidelines.md
          - Deployment Templates: dev-guidelines/deployment_templates.md
          - Cloud Deployment:
              - Cloud Deployment: dev-guidelines/cloud_deployment.md
              - AWS: dev-guidelines/cloud_deployment_aws.md
              - GCP: dev-guidelines/cloud_deployment_gcp.md
              - Azure: dev-guidelines/cloud_deployment_azure.md
      - System Design Guidelines:
          - System Design Intro: dev-guidelines/system_design_guidelines.md
          - Low-level Design: dev-guidelines/low_level_design.md
          - Database Design: dev-guidelines/database_design.md
          - Software Architectures: dev-guidelines/software_architecture.md
          - High-level Architecture Design: dev-guidelines/high_level_design.md
  - Resources:
      - All Resources: resources/index.md
      - References: resources/references.md
      - Apps & Tools references: resources/app_tools_references.md
      - Tutorials: resources/tutorials.md
      - VSCode Configs, Profile & Extensions: resources/vscode_configs.md
      - Other Configs: resources/configs.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/SerendipityOrg/TradeMan-Dev-Guidelines