Waypoint icon indicating copy to clipboard operation
Waypoint copied to clipboard

Documentation generated site, SEO and SOME-sharing

Open Thorium opened this issue 5 years ago • 2 comments

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

Thorium avatar Jun 11 '20 13:06 Thorium

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 avatar Jun 11 '20 13:06 Thorium

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

Thorium avatar Jun 11 '20 13:06 Thorium