Component documentation in Markdown 2/2 #13203
Conversation
✨ GUI Checks ResultsSummary
See individual check results for more details. ℹ️ Chromatic Tests SkippedChromatic visual regression tests were skipped for this PR. To run the tests and deploy Storybook, add the Note: We skip tests by default to optimize CI costs. Only run them when your UI changes are ready for review. 👮 Lint GUI ResultsCheck Results
🎭 Playwright Test ResultsSummary
|
🔄 GUI Checks in ProgressThe following checks are being performed:
Results will be updated here once completed. |
| @@ -38,7 +38,7 @@ export class SuggestionDb extends ReactiveDb<SuggestionId, SuggestionEntry> { | |||
| [entry.definitionPath.key(), id], | |||
| ]) | |||
| readonly childIdToParentId = new ReactiveIndex(this, (id, entry) => { | |||
| const parentAndChild = entry.definitionPath.splitAtName() | |||
| const parentAndChild = entry.definitionPath.normalized().splitAtName() | |||
There was a problem hiding this comment.
I think this one is correct, because it allows Standard.Base.Main.Something to be recognized as Standard.Base parent and Something child. Also see modification in projectPaths.
| const projectKey = this.project ?? '$' | ||
| return this.path ? `${projectKey}.${this.path}` : projectKey | ||
| const normalized = this.normalized() | ||
| const projectKey = normalized.project ?? '$' | ||
| return normalized.path ? `${projectKey}.${normalized.path}` : projectKey |
There was a problem hiding this comment.
This one is errr... questionable, but I find it fixed issues with Standard.Base.Main being referred as Standard.Base.Main in suggestion db while as Standard.Base everywhere else. @kazcw do you think this is a correct modification? I lose track of where we normalize Main and where we don’t.
There was a problem hiding this comment.
I think that's good: we should use normalized names everywhere except when sending paths to LS.
vitvakatu
requested review from
Frizi,
farmaazon,
kazcw,
AdRiley,
PabloBuchu,
indiv0,
somebody1234 and
JaroslavTulach
as code owners
| const projectKey = this.project ?? '$' | ||
| return this.path ? `${projectKey}.${this.path}` : projectKey | ||
| const normalized = this.normalized() | ||
| const projectKey = normalized.project ?? '$' | ||
| return normalized.path ? `${projectKey}.${normalized.path}` : projectKey |
There was a problem hiding this comment.
I think that's good: we should use normalized names everywhere except when sending paths to LS.
app/gui/src/project-view/components/ComponentBrowser/ComponentList.vue
Outdated
Show resolved
Hide resolved
Pull Request Description
Second part of #12983
This removes the doc parser, addresses the remaining review comments from the first PR, and fixes some minor issues in documentation breadcrumbs.
This one should be merged after migration to the markdown in the stdlib docs.
markdown-docs-part-2.mp4
Important Notes
Integration tests are failing because we need to regenerate the mock suggestions file. It will be easier when the docs in the stdlib are updated to the new format.
Checklist
Please ensure that the following checklist has been satisfied before submitting the PR:
Scala,
Java,
TypeScript,
and
Rust
style guides. In case you are using a language not listed above, follow the Rust style guide.
or the Snowflake database integration, a run of the Extra Tests has been scheduled.