Skip to content

Latest commit

 

History

History
64 lines (47 loc) · 2.01 KB

AGENTS.md

File metadata and controls

64 lines (47 loc) · 2.01 KB

AGENTS.md

This file provides important project context and guidelines to agentic tools when working with them on content and code for the Dart programming language website.

Project overview

This repository contains the source code and content for the official Dart programming language website, hosted at dart.dev.

The website is statically built and implemented with Dart and the Jaspr web framework. For loading content, data, and some assets, it uses Jaspr Content.

Directory structure

  • src/content/: Markdown based documentation pages.
  • src/data/: YAML and JSON data files used by the site, such as for the sidenav, glossary, and changelog.
  • src/_includes/: Liquid partial files written in Markdown.
  • examples/: Dart code examples workspace, referenced by code excerpts in the Markdown files.
  • site/: The Jaspr and Jaspr Content based site implementation.
  • tool/dash_site/: CLI tool for site development and maintenance.

Common commands

While working on the site, you might need to run these commands:

dart pub get                         # Install or update Dart dependencies.
dart run dash_site serve             # Serve a dev server of the site locally.
dart run dash_site build             # Build a production version of the site.
dart run dash_site refresh-excerpts  # Sync code excerpts to Markdown files.
dart run dash_site --help            # Learn what other commands are available.

Content guidelines

Writing style

Writing should be consistent across the site and follow the Google developer documentation style guide.

Line breaks

In Markdown files, use semantic line breaks and try to keep each line under 80 characters long.

Coding guidelines

All Dart code should follow Effective Dart, unless purposefully not for explanatory or pedagogical purposes.