QwikDev / QwikDev/qwik

[📖] the docs e2e test should run as part of CI

Open
#7,905 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs PR welcomed
Dominant language
TypeScript
Stars
22.1k
Forks
1.4k
Avg merge
1d 10h
Merged PRs (30d)
52

Description

Suggestion

We now have /e2e/docs-e2e which tests the docs, but it doesn't run automatically.

It should be run as part of CI if and after docs were built successfully.

Right now uses docs.dev, but it could also run preview; the client was already built.

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 with /e2e/docs-e2e and the CI configuration that builds the docs. Verify the docs build completes before the e2e job and decide whether it targets docs.dev or preview; done when the test runs automatically in CI only after a successful docs build.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
ci-cd, documentation, testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.