docs: adding og tags #17
Closed
Conversation
This file contains 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
This is non-working and mostly a check in. In addition to the server, there is a new set of commands to manage resources (which is integrated into the server itself). The end goal is to have a user's session state recorded in k8s with events + resources.
Kustomize was just too difficult to get working well in getting started. This introduces an `install` and `delete` command that does it for all resources, not just the CRD. There's some minimal patching that happens to the resources so that they hopefully can still be applied with `kubectl` directly from the repo.
There was somewhat significant refactoring required to get this to work - the effect needed to be created from the previous buffer. This meant that: - Dispatch had to be moved *after* the draw call, so that the current buffer was drawn. Ratatui gives an empty buffer on every render call. - Assume that `Dispatch::Consumed` means that we want to re-render everything. This triggers the tick immediately and assumes that if an event was consumed - it was because we want to redraw. It gets away from weird UI lag between input and rendering. - Pass the buffer through dispatch as a reference. - Converted the bundle trait over to a widget. This allows us to keep state in the widget itself and gets rid of the super weird passthrough effects. - Move animation out of the bundle and into widgets themselves. The `Animated` widget is a very light wrapper that can optionally render things. - Use `Option<Effect>` instead of `Vec<Effect>`. It is much easier to work with from an implementation perspective and `fx::parallel` works fine. Some other good changes in here: - Store now returns a oneshot that allows for adding/removing a loading screen. Now the screen is removed on loading in pod list. - Loading is now a `widget::Widget` instead of a `ratatui::WidgetRef`. - `Debug` now does a sum of the ring buffer to calculate fps, so it is more accurate. = `Debug` now shows how long the last tick was, to understand UI latency.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Reviewer's Guide by SourceryThis pull request adds Open Graph (OG) tags to improve the website's metadata for better sharing on social media platforms. The changes are implemented in the File-Level Changes
Tips
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @grampelberg - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
| const title = `${config.title} – kty` | ||
| const description = | ||
| config.frontMatter.description || 'kty: Terminal for Kubernetes' | ||
|
|
||
| const image = config.frontMatter.image || '/logo-dark-500x500.png' | ||
| const image = config.frontMatter.image || '/logo-dark.gif' |
There was a problem hiding this comment.
question (performance): Reconsider using GIF for the default logo image
Is there a specific reason for changing the default image from PNG to GIF? GIFs often have lower quality for static images and larger file sizes. If animation isn't required, consider using a more efficient format like PNG or WebP.
| @@ -48,6 +52,9 @@ const config: DocsThemeConfig = { | |||
| <meta property="og:description" content={description} /> | |||
| <meta name="og:image" content={image} /> | |||
| <meta name="og:image:alt" content={title} /> | |||
| <meta property="og:locale" content="en_us" /> | |||
| <meta property="og:url" content={`https://kty.dev${pathname}`} /> | |||
There was a problem hiding this comment.
suggestion: Use URL constructor for more robust URL handling
Consider using the URL constructor for more robust URL handling. This would be especially beneficial if you plan to add query parameters or hash fragments in the future. For example: new URL(pathname, 'https://kty.dev').toString()
Suggested change
| <meta property="og:url" content={`https://kty.dev${pathname}`} /> | |
| <meta | |
| property="og:url" | |
| content={new URL(pathname, 'https://kty.dev').toString()} | |
| /> |
grampelberg
force-pushed
the
thomas--og
branch
from
d91cc02 to
d79f5a7
Compare
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.
Summary by Sourcery
Enhance the documentation site by adding Open Graph meta tags, including locale, URL, and type, to improve social media sharing and SEO.
Documentation: