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.

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

add some known issues #2193

Merged
merged 1 commit into from
Jan 10, 2025
Merged

add some known issues #2193

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions docs/known_issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,27 @@

# Known issues

_There remain several known issues with ViewComponent. We'd be thrilled to see you consider solutions to these thorny bugs!_

## Limited i18n support

ViewComponent currently only supports sidecar translation files. In some cases, it could be useful to support centralized translations using namespacing:

Check warning on line 13 in docs/known_issues.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Microsoft.Wordiness] Consider using 'sometimes' instead of 'In some cases'.

Raw Output:
{"message": "[Microsoft.Wordiness] Consider using 'sometimes' instead of 'In some cases'.", "location": {"path": "docs/known_issues.md", "range": {"start": {"line": 13, "column": 66}}}, "severity": "WARNING"}

```yml
en:
view_components:
login_form:
submit: "Log in"
nav:
user_info:
login: "Log in"
logout: "Log out"
```

## Lack of Jekyll support

It would be lovely if we could support rendering ViewComponents in Jekyll, as it would enable the reuse of ViewComponents across static and dynamic (Rails-based) sites.

## Issues resolved by the optional capture compatibility patch

If you're experiencing issues with duplicated content or malformed HTML output, the capture compatibility patch may resolve these.
Expand Down
Loading