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.

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

docs: add <meta> tags (Group 1) #950

Merged
merged 2 commits into from
Mar 11, 2024

Conversation

marcpicaud
Copy link
Contributor

Summary

This PR adds <meta> tags to the pages listed as "Group 1" in this issue #791 .

I tried to be as descriptive as possible and to use relevant keywords for the FBW cause.

I'm not a SEO expert though and English is not my primary language so feel free to nitpick the wording. If this is useful, I'll be happy to add meta tags to the remaining groups in #791.

Location

For the pages listed in "Group 1" in this issue flybywiresim#791
Copy link

vercel bot commented Mar 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 9, 2024 7:06pm

@github-actions github-actions bot added support Changes to Support Directory Review Required PR Check Label labels Mar 9, 2024
@marcpicaud marcpicaud changed the title docs: add <meta> tags docs: add <meta> tags (Group 1) Mar 9, 2024
@Valastiri
Copy link
Member

Hey there - this is certainly quite useful and something I have been wanting to do for a while. Let me look over it this weekend and maybe we can finally get some work done on this. Thanks for opening this PR!

Copy link
Member

@Valastiri Valastiri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initial pass is great.

One note is typical best practice for SEO is between 150-160 characters otherwise search engines (or even maybe our open graph plugin) would truncate the meta description. (I can verify this manually later if it does).

It's not a strict limit and the current descriptions are actually great that I don't think minimizing character count is super important.

Simply put the only minor concern is the visual portion with the social media opengraph embeds.

@@ -1,3 +1,8 @@
---
title: Experimental Version
description: Explore the Experimental version of the FlyByWire A32NX add-on for Microsoft Flight Simulator 2020.
Copy link
Member

@Valastiri Valastiri Mar 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe better to mention that Experimental is discontinued or instead of "explore" use "information about the [...]".

@marcpicaud
Copy link
Contributor Author

Hey there,

Thanks a lot for the quick and kind review!

I've shortened the longest descriptions, none of them are over 150 chars now. Happy to edit furthermore if needed.

Cheers!

@Valastiri
Copy link
Member

This is honestly great -- appreciate the work and am glad we're getting this out of the way. lgtm thanks!

@github-actions github-actions bot removed the Review Required PR Check Label label Mar 11, 2024
@github-actions github-actions bot merged commit 515e377 into flybywiresim:primary Mar 11, 2024
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved support Changes to Support Directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants