score-spec/docs

Score Specification Docs is a documentation site built with Hugo that covers the Score Specification and its implementations.

The project solves the problem of providing centralized, accessible documentation for the Score Specification. It uses Hugo as a static site generator to build and deploy documentation through GitHub Pages, with the site served at docs.score.dev. The documentation is maintained using standard web development tooling, with yarn managing dependencies and ensuring consistent versions of Hugo and related tools across environments.

Developers maintaining or contributing to Score-related projects should use this repository if they need to update or extend the specification documentation. The site suits teams working with Score implementations who want a single source of truth for how to use and integrate Score. The project includes tooling for local development, allowing contributors to preview changes before deployment. It integrates external content from other repositories to populate a Score example hub, automatically pulling and generating example pages from remote sources.

The project maintains active documentation practices through automated formatting and linting. The tool uses dprint for code formatting and Vale with the Google Developer Documentation Style Guide for prose linting, ensuring consistency across all documentation. The repository includes troubleshooting guidance for common Hugo build issues and clear instructions for both local development and content generation workflows. Contributors can fork the repository and submit pull requests to suggest improvements, with a defined enhancement tag for tracking documentation suggestions.