oasisprotocol / oasisprotocol/docs

Add cypress tests

Open
#5 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ci p:2 tests
Dominant language
TypeScript
Stars
15
Forks
46
Avg merge
1d 21h
Merged PRs (30d)
1

Description

Add cypress tests which spin up the documentation site locally and:

  • visit landing page, reloading, clicking on different kind of links (sidebar, other internal page, external page, top-left logo)
  • visit some inner general, oasis-core, oasis-sdk, oasis-core-ledger pages
  • check generated pages (type: autogenerated)
  • check specific components like DocCard (both generated and manual)
  • checking no-javascript version of the site

All tests should click and check, if the links on the apge are correctly working and then also try reloading the site and checking them again (e.g. to catch #4).

Contributor guide

No contributing guide indexed for this repository

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 the Cypress setup and the locally running documentation site. Cover the landing page, internal and external links, listed general, oasis-core, oasis-sdk, and oasis-core-ledger pages, generated pages, DocCard variants, and the no-JavaScript version; reload during each flow to catch issues such as #4. Done means all links work before and after reloads.

Written by the indexing model from the issue text.

Assessment

Tech stack
cypress, typescript
Domain
documentation, testing, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.