# fossasia/yaydoc

Docs! Yay!

Repository: https://github.com/fossasia/yaydoc
Canonical: https://ross.abutalabs.com/products/yaydoc
Language: JavaScript
License: GPL-3.0
License Family: copyleft
Archived: true
Last push: 2022-12-07T07:03:25+00:00

## Health v2 (maintenance only)
Score: 10/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 3405, "days_push": 1365, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, archived
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1542, forks 124 (observed 2026-08-28T04:05:01.067936+00:00)

## What it is
Yaydoc is an automated documentation generation and deployment service that builds documentation from registered GitHub repositories on each commit and publishes it to GitHub Pages. It is configured via a .yaydoc.yml file and can be self-hosted on Heroku, Kubernetes, or other platforms.

## Use cases
- automatically build docs from my github repo on every push
- deploy sphinx documentation to github pages
- generate documentation from markdown and rst files
- set up continuous documentation deployment
- self-host a documentation build service

## When to choose
- you want docs rebuilt and deployed automatically on each commit
- your docs live in markdown or reStructuredText in a GitHub repo
- you want a self-hostable documentation CI service

## When to avoid
- you need actively maintained tooling with recent updates
- you use non-Sphinx documentation toolchains
- you need docs hosting beyond GitHub Pages

## Facets
- artifact type: service
- maturity: maintenance
- function: documentation, deployment, ci-cd, http-server
- domain: documentation, web-development, developer-tools
- platform: self-hosted
- tags: docs-generation, github-pages, sphinx, heroku, continuous-documentation, automation, web-server, nodejs, docker

## Member repositories
- fossasia/yaydoc (main) score 10

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:01.067936+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T04:30:44.293580+00:00, confidence not recorded.
  - readme: https://github.com/fossasia/yaydoc (fetched 2026-08-28T04:05:01.067936+00:00, sha fcee0ca9989d)
- Data as of 2026-08-30T08:39:29.467469+00:00.