Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: adding docusaurus docs project #164

Closed
wants to merge 105 commits into from

Conversation

amelnytskyi
Copy link
Contributor

What ❔

Adding initial scope of Docusaurus project for testing docs (with examples of tests - more to be added later)

Why ❔

Migrating test documentation to GitHub

Checklist

  • PR title corresponds to the body of PR (we generate changelog entries from PRs).
  • Tests for the changes have been added / updated.
  • Documentation comments have been added / updated.

@amelnytskyi amelnytskyi self-assigned this Feb 6, 2024
Copy link

github-actions bot commented Feb 6, 2024

Unit Test Results

    4 files    263 suites   10m 48s ⏱️
2 081 tests 2 080 ✅ 1 💤 0 ❌
2 290 runs  2 289 ✅ 1 💤 0 ❌

Results for commit bb17a08.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Feb 6, 2024

API E2E Test Results

207 tests   207 ✅  20s ⏱️
 14 suites    0 💤
  1 files      0 ❌

Results for commit bb17a08.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Feb 7, 2024

Visit the preview URL for this PR (updated for commit bb17a08):

(expires Thu, 09 May 2024 11:44:14 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: e508f9012944951194447cb8885950b451a24403

@pcheremu
Copy link
Collaborator

pcheremu commented Apr 9, 2024

@amelnytskyi I have fixed package conflicts, now you can fill the documentation.

  1. Please update Readme to use npm run build and npm run start instead of yarn
  2. I suppose we need remove all demo content from this example
  3. In case of an conflict with packages, please let me know. Latest package versions should be build first. The problem was in "react" dependencies.
  4. app project has conflicts with node > 18 and contains many outdated packages. As a workaround you can cut it from packages to update required packages (if any) and place app back to packages with running npm install. Make sure that npm run build each time before commit has 0 errors.

@amelnytskyi
Copy link
Contributor Author

@pcheremu thanks for help - great job!
Next I will proceed with removing obsolete content and adding new cases

@abilevych
Copy link
Collaborator

@pcheremu Thanks, well done.

Regarding the review - from my side, it is all right.

The thing is that inside of your changes have been touched the package-lock.json at the root of dev solution (I understand we cannot avoid that), which means we certainly need to get a review from @vasyl-ivanchuk or/and @Romsters.

Guys, can you please take a look at the PR?

@pcheremu
Copy link
Collaborator

pcheremu commented Apr 10, 2024

Thank you,

Regarding the review process testing-docs - this is a template for now, I would ask for review for now only for 2 workflow files and lock file (that I regenerated in the following sequence: testing-docs -> worker -> fetcher -> api -> app). After completing the cleaning and filling the content to Docusaurus it will make sense to check it too. Just fyi.

image

@pcheremu pcheremu added documentation Improvements or additions to documentation automation writing/fixing/maintaining auto-tests/e2e-tests labels Apr 15, 2024
@pcheremu pcheremu self-assigned this Apr 15, 2024
pcheremu and others added 27 commits May 2, 2024 13:38
fixing structure and broken page
…232)

# What ❔
Move Debugger test cases to archived folder - currently this
functionality is not available on BE side.

## Why ❔



## Checklist


- [ ] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [ ] Documentation comments have been added / updated.
# What ❔

- [ ] Screenshots added
- [ ] 404 pages fixed
- [ ] remove labels (manual + automated in the same case)
- [ ] remove labels (like ticket connection UEXP/ZKF)
- [ ] remove labels (only Automated OR Partly manual)
- [ ] Formatting is fixed 

## Why ❔



## Checklist



- [ ] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [ ] Documentation comments have been added / updated.
# What ❔

- [x] Screenshots added
- [x] 404 pages fixed
- [x] remove labels (manual + automated in the same case)
- [x] remove labels (like ticket connection UEXP/ZKF)
- [x] remove labels (only Automated OR Partly manual)
- [x] Formatting is fixed 

## Why ❔

<!-- Why are these changes done? What goal do they contribute to? What
are the principles behind them? -->
<!-- Example: PR templates ensure PR reviewers, observers, and future
iterators are in context about the evolution of repos. -->

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [x] Tests for the changes have been added / updated.
- [x] Documentation comments have been added / updated.
# What ❔

- [x] Screenshots added
- [x] 404 pages fixed
- [x] remove labels (manual + automated in the same case)
- [x] remove labels (like ticket connection UEXP/ZKF)
- [x] remove labels (only Automated OR Partly manual)
- [x] Formatting is fixed 

## Why ❔

<!-- Why are these changes done? What goal do they contribute to? What
are the principles behind them? -->
<!-- Example: PR templates ensure PR reviewers, observers, and future
iterators are in context about the evolution of repos. -->

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [x] Tests for the changes have been added / updated.
- [x] Documentation comments have been added / updated.
# What ❔

- [x] Screenshots added
- [x] 404 pages fixed
- [x] remove labels (manual + automated in the same case)
- [x] remove labels (like ticket connection UEXP/ZKF)
- [x] remove labels (only Automated OR Partly manual)
- [x] Formatting is fixed 

## Why ❔

<!-- Why are these changes done? What goal do they contribute to? What
are the principles behind them? -->
<!-- Example: PR templates ensure PR reviewers, observers, and future
iterators are in context about the evolution of repos. -->

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [x] Tests for the changes have been added / updated.
- [x] Documentation comments have been added / updated.
)

# What ❔

- [ ]  Screenshots added
- [ ]  404 pages fixed
- [ ]  remove labels (manual + automated in the same case)
- [ ]  remove labels (like ticket connection UEXP/ZKF)
- [ ]  remove labels (only Automated OR Partly manual)
- [ ]  Formatting is fixed

## Why ❔

## Checklist

- [ ] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [ ] Documentation comments have been added / updated.
)

# What ❔

- [x] Screenshots added
- [x] 404 pages fixed
- [x] remove labels (manual + automated in the same case)
- [x] remove labels (like ticket connection UEXP/ZKF)
- [x] remove labels (only Automated OR Partly manual)
- [x] Formatting is fixed 

## Why ❔

<!-- Why are these changes done? What goal do they contribute to? What
are the principles behind them? -->
<!-- Example: PR templates ensure PR reviewers, observers, and future
iterators are in context about the evolution of repos. -->

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [x] Tests for the changes have been added / updated.
- [x] Documentation comments have been added / updated.
…ens + Transactions pages part (#243)

# What ❔

- [x] Screenshots added
- [x] 404 pages fixed
- [x] remove labels (manual + automated in the same case)
- [x] remove labels (like ticket connection UEXP/ZKF)
- [x] remove labels (only Automated OR Partly manual)
- [x] Formatting is fixed 

Links:

1.
https://linear.app/matterlabs/issue/QA-802/[docusaurus]-add-screenshots-and-check-test-case-correctness-of-import
2.
https://linear.app/matterlabs/issue/QA-803/[docusaurus]-add-screenshots-and-check-test-case-correctness-of-import
3.
https://linear.app/matterlabs/issue/QA-802/[docusaurus]-add-screenshots-and-check-test-case-correctness-of-import

## Why ❔

<!-- Why are these changes done? What goal do they contribute to? What
are the principles behind them? -->
<!-- Example: PR templates ensure PR reviewers, observers, and future
iterators are in context about the evolution of repos. -->

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [x] Tests for the changes have been added / updated.
- [x] Documentation comments have been added / updated.
# What ❔

- [x] Screenshots added
- [x] remove labels (manual + automated in the same case)
- [x] remove labels (like ticket connection UEXP/ZKF)
- [x] remove labels (only Automated OR Partly manual)
- [x] Formatting is fixed

## Why ❔



## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [ ] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [ ] Documentation comments have been added / updated.
# What ❔

Add Active tag to all test cases. 
Clean-up unnecessary tags. 

## Why ❔


## Checklist

- [ ] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [ ] Documentation comments have been added / updated.
…r-labs/block-explorer into QA-613-add-docusaurus-docs-project
@pcheremu pcheremu marked this pull request as draft May 2, 2024 11:41
@pcheremu pcheremu closed this Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation writing/fixing/maintaining auto-tests/e2e-tests documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants