Skip to content

Link hovers to real documentation pages (0.3.2) #7

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.

Sign up for GitHub

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

Merged
zabarov merged 2 commits into from
Oct 30, 2026
Merged

Link hovers to real documentation pages (0.3.2) #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e034a37
Link hovers to real documentation pages
zabarov Oct 30, 2026
dceae17
Expect the documentation page link in the tag hover test
zabarov Oct 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/freshness.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ jobs:
node-version: 22
cache: npm

- name: Documentation pages are still published
run: |
npm ci
npm run docs:check

- name: Compare releases
id: compare
env:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ jobs:
node-version: 22
cache: npm
- run: npm ci
- name: Documentation pages are still published
run: npm run docs:check
- name: Package
id: package
run: |
Expand Down
15 changes: 15 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

All notable changes to SIMAI Framework for VS Code (formerly SIMAI Framework IntelliSense) are listed here.

## [0.3.2] - 2026-10-30

### Fixed

- Documentation links in hovers led to pages that do not exist, such as
`/smart.buttons`. Hovers now link to the real page of the tag or utility on
https://ui.simai.io, for example `/ru/smart-components/actions/buttons/`.
Links are built only from pages the site lists (`contracts/docs-pages.json`),
and the release and a weekly check fail if a recorded page disappears.

### Changed

- `sf.docs.baseUrl` now defaults to `https://ui.simai.io`, so the links work
without configuration. Set it to empty for no link.

## [0.3.1] - 2026-10-20

### Changed
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Bitrix templates. In markup, class attributes, `sf-` tags and `--sf-` tokens in
| `sf.diagnostics.enabled` | `true` | Report deprecated and likely misspelt Framework names. |
| `sf.diagnostics.unknownSeverity` | `information` | `off`, `hint`, `information`, `warning` or `error` for likely misspellings. |
| `sf.diagnostics.deprecatedSeverity` | `warning` | The same choices for deprecated tags and attributes. |
| `sf.docs.baseUrl` | empty | Base URL of the SIMAI Framework documentation site. When set, hovers link to `<baseUrl>/<registry ID>`, for example `<baseUrl>/smart.buttons`. |
| `sf.docs.baseUrl` | `https://ui.simai.io` | Base URL of the SIMAI Framework documentation site that hovers link to. Leave empty for no link. |

## What is suggested

Expand Down
Loading
Loading