From 66401e0e147286017b4ce00ebfc3f407cd69dd6b Mon Sep 17 00:00:00 2001 From: Alex Ackermann Date: Fri, 11 Apr 2025 10:24:36 +0200 Subject: [PATCH 1/2] Enable generated index for web dev docs --- docs/dev/20-web/20-development/_category_.json | 7 ++++++- docs/dev/20-web/20-development/index.md | 10 ---------- docs/dev/20-web/30-testing/_category_.json | 7 ++++++- docs/dev/20-web/30-testing/index.md | 5 ----- 4 files changed, 12 insertions(+), 17 deletions(-) delete mode 100644 docs/dev/20-web/20-development/index.md delete mode 100644 docs/dev/20-web/30-testing/index.md diff --git a/docs/dev/20-web/20-development/_category_.json b/docs/dev/20-web/20-development/_category_.json index d07b6dbf..1e3764f7 100644 --- a/docs/dev/20-web/20-development/_category_.json +++ b/docs/dev/20-web/20-development/_category_.json @@ -1,4 +1,9 @@ { "label": "Development", - "position": 2 + "position": 2, + "link": { + "type": "generated-index", + "description": "\uD83D\uDC69\u200D\uD83D\uDCBB Development", + "slug": "dev/web/development" + } } diff --git a/docs/dev/20-web/20-development/index.md b/docs/dev/20-web/20-development/index.md deleted file mode 100644 index d3b5390b..00000000 --- a/docs/dev/20-web/20-development/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: 'Development' ---- - - - -This section is a guide about the development of OpenCloud Web **core**, **apps** and **extensions**. -This includes **tooling**, **conventions** and the **repo structure**. - -It is of interest for you if you want to contribute to OpenCloud Web or develop your own apps and extensions. diff --git a/docs/dev/20-web/30-testing/_category_.json b/docs/dev/20-web/30-testing/_category_.json index 22d3090e..d67ea3ea 100644 --- a/docs/dev/20-web/30-testing/_category_.json +++ b/docs/dev/20-web/30-testing/_category_.json @@ -1,4 +1,9 @@ { "label": "Testing", - "position": 3 + "position": 3, + "link": { + "type": "generated-index", + "description": "✅ Testing", + "slug": "dev/web/testing" + } } diff --git a/docs/dev/20-web/30-testing/index.md b/docs/dev/20-web/30-testing/index.md deleted file mode 100644 index 5b72c92d..00000000 --- a/docs/dev/20-web/30-testing/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'Testing' ---- - -Guides on running different kinds of tests in OpenCloud Web. From ad30064620f200baedd35c7ffcf83bb0d2b44ace Mon Sep 17 00:00:00 2001 From: Alex Ackermann Date: Fri, 11 Apr 2025 10:29:42 +0200 Subject: [PATCH 2/2] Fix broken links --- docs/dev/20-web/20-development/10-conventions.md | 2 +- docs/dev/20-web/20-development/20-repo-structure.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dev/20-web/20-development/10-conventions.md b/docs/dev/20-web/20-development/10-conventions.md index 6b5b34a6..76cfa33b 100644 --- a/docs/dev/20-web/20-development/10-conventions.md +++ b/docs/dev/20-web/20-development/10-conventions.md @@ -20,7 +20,7 @@ for a suitable one and open a pull request! To make sure your pull request can be efficiently reviewed and won't need a lot of changes down the road, please run the linter and the unit tests via `pnpm lint --fix` and `pnpm test:unit` locally. Our [CI](https://drone.opencloud.eu/opencloud/web) will run on pull requests and report back any problems after that. For a further introduction on how we handle testing, please head to -the [testing docs](./../30-testing/index.md). +the [testing docs](./../30-testing/10-running-tests.md). ## Code Conventions diff --git a/docs/dev/20-web/20-development/20-repo-structure.md b/docs/dev/20-web/20-development/20-repo-structure.md index dd838095..14bb7dba 100644 --- a/docs/dev/20-web/20-development/20-repo-structure.md +++ b/docs/dev/20-web/20-development/20-repo-structure.md @@ -29,7 +29,7 @@ Having these packages side by side within the `/packages` folder of the repo is We're using [Playwright](https://playwright.dev) for UI testing. The UI tests are located in `/tests/e2e`. You're more than welcome to make a pull request and adjust this section of the docs accordingly. :-) -You can read more about testing in our [testing section](./../30-testing/index.md) +You can read more about testing in our [testing section](./../30-testing/10-running-tests.md) ### package.json File