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

Jump to bottom

Documentation generated site, SEO and SOME-sharing #27

Open
Thorium opened this issue Jun 11, 2020 · 2 comments
Open

Documentation generated site, SEO and SOME-sharing #27

Thorium opened this issue Jun 11, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Thorium
Copy link

Thorium commented Jun 11, 2020

Search engine optimisations to improve F#-tooling-awareness.

Besides the current <title> The templates should generate the following meta tags content to the page <header>, at least descriptions, keywords, etc:

<meta property="og:site_name" content="Product name">
<meta name="description" content="Small description of the project." />
<meta name="keywords" content="fsharp" />
<meta property="og:image" content="http://non-ssl-path-logo.png">
<meta property="og:image:secure_url" content="https://.../logo.png">
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/logo.png" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:site" content="@fsharporg" />
<meta name="robots" content="index,follow" />
<meta name="rating" content="general" />

I think url-routing is quite ok as it is, but the double-slash could be removed, e.g.:
https://moiraesoftware.github.io/myriad//tutorials/debugging.html
@Krzysztof-Cieslak Krzysztof-Cieslak added enhancement New feature or request documentation Improvements or additions to documentation labels Jun 11, 2020
@Thorium
Copy link
Author

Thorium commented Jun 11, 2020

Other SEO: Only one H1 per page, now there is the product name, and the page name. (e.g. <h1>Myriad</h1> and <h1>Using external plugins</h1>), the sub-titles should be H2 instead.

The link to main page should forward rather the site root than "index.html", so that there wouldn't be "duplicate context" of siteroot and index.html. Also sitemap.xml and robots.txt would be excellent:

sitemap.xml:

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="sitemapschema.xsl"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" 
        xmlns:xhtml="http://www.w3.org/1999/xhtml">
    <url><loc>debugging.html</loc><priority>1.0</priority></url>
    <url><loc>turorials.html</loc><priority>1.0</priority></url>
   <!-- ... -->
</urlset>

robots.txt:

User-agent: *
Sitemap: sitemap.xml

@Thorium
Copy link
Author

Thorium commented Jun 11, 2020

...and add <!DOCTYPE html> to the top of the html page

@baronfel baronfel mentioned this issue Jun 11, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Thorium @Krzysztof-Cieslak