Merged
Conversation
Gives the Web dev docs a much needed overhaul, fixes dead links and formats all md files in a consistent way.
Contributor
There was a problem hiding this comment.
Pull Request Overview
Overhauling the Web development docs with improved consistency in markdown formatting and updated links, instructions, and configuration examples. Key changes include:
- Revised testing, installation, and configuration documentation to improve clarity.
- Updated extension system docs to replace outdated “scopes” with “extensionPointIds” and to align icon source references.
- Reorganized sections (e.g. tooling and repo structure) for improved readability and usability.
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/dev/web/testing/running-tests.md | Updated introduction and test instructions with clearer assumptions. |
| docs/dev/web/testing/e2e-testing-standards.md | Removed extraneous examples and updated a code sample to use consistent syntax. |
| docs/dev/web/getting-started.md | Reorganized installation and configuration sections with updated links. |
| docs/dev/web/extension-system/*.md | Standardized usage of extensionPointIds, updated import formatting, and revised icon source comments. |
| docs/dev/web/embed-mode.md | Reformatted the iframe example for improved markdown clarity. |
| docs/dev/web/development/tooling.md | Enhanced instructions with updated commands and setup notes for instant hot-reloading. |
| docs/dev/web/development/repo-structure.md | Refined descriptions of repo components and package details. |
| docs/dev/web/development/conventions.md | Updated conventions with a focus on modern TypeScript and Composition API usage. |
Comments suppressed due to low confidence (3)
docs/dev/web/extension-system/index.md:67
- Ensure that the change from the previous icon source URL to Remix Icon is consistently applied across all extension docs for clarity.
icon: 'aliens', // See https://remixicon.com/ for available options
docs/dev/web/development/tooling.md:43
- [nitpick] Confirm that running the OpenCloud server in detached mode (-d) aligns with your development workflow requirements.
$ docker-compose up opencloud -d
docs/dev/web/extension-system/extension-types/left-sidebar-menu-item-extensions.md:49
- Verify that replacing 'scopes' with 'extensionPointIds' in this extension configuration is consistent with the expected configuration across your extension system.
extensionPointIds: ['app.files.navItems'],
phil-davis
reviewed
Apr 17, 2025
Co-authored-by: Phil Davis <phil@jankaritech.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Gives the Web dev docs a much needed overhaul, fixes dead links and formats all md files in a consistent way.