sitespeedio / sitespeedio/sitespeed.io

Create a tutorial section

Open
#3,598 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
JavaScript
Stars
5k
Forks
624
Avg merge
4h 8m
Merged PRs (30d)
2

Description

Feature/improvement

We should be inspired by https://grafana.com/tutorials/ and see if we can rework the documentation and follow some of the structure for Grafana documentation.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing sitespeed.io documentation and the Grafana tutorials linked in the issue. Determine which tutorial topics and documentation structure should be included, then document the agreed scope before implementation. Done means a published tutorial section with a clear, useful structure modeled appropriately for sitespeed.io.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.