layer5io/docs

0

/ 100

Documentation91
Engineering79
Health97
JavaScript92Apache-2.01d ago
Grade a repo

Well engineered for its size. A portfolio piece worth showing off.

Documentation and Developer resources for Layer5 products

Documentation

91

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

Contributing guide5pt97

Contributing guide is detailed and thorough.

License6pt100

Licensed under Apache-2.0.

Engineering

79

CI/CD14pt57

CI is configured (.github/workflows/build-and-preview-docs.yml).

Tests18pt80

A test script is configured in package.json.

Reproducibility6pt85

Lockfile present (go.sum). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.prettierrc).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

97

Dependency manifest6pt92

Dependency manifest found (go.mod).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 195
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 92
    Watchers

Responsiveness

  • 14h
    Median issue response
  • <1h
    Median PR merge time
  • 90
    Open issues
Repository files34 root entries
  • .github
    Good: CI is configured (.github/workflows/build-and-preview-docs.yml).
    Good: Issue or PR templates present.
  • archive
  • assets
  • build
  • charts
  • content
  • data
  • docs
  • i18n
  • layouts
  • proposals
  • static
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • .nvmrc
  • .prettierignore
  • .prettierrc
    Good: Linter or formatter configured (.prettierrc).
  • build-digest.py
  • CNAME
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • compose.yaml
  • config.yaml
  • CONTRIBUTING-gitflow.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • hugo.toml
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • package-lock.json
  • package.json
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • SECURITY.md
    Good: Security policy present.