You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Modify the DocC website generation tooling so that the content of each page can be indexed by all search-engines (google, bing, etc.).
Currently, the DocC-generated website doesn't support search indexing. Case in point:
The indexed content for the DocC-generated website is the <noscript> content, "This page requires JavaScript. Please turn on JavaScript in your browser and refresh the page to view its content."
As a user searching for documentation about an open source library whose documentation is generated with DocC and hosted on the web, I should be able to search for said documentation content on google, bing, etc. and find relevant search results, deep-linked into the specific pages of documentation.
Importance
The success of an open source project is largely dependent on its discoverability, and secondarily, it's ease of adoption. Well-hosted and discoverable documentation is a key part of ensuring this success.
Alternatives Considered
Rebuilding the website by hand saving the rendered DOM for each page and building a sitemap by hand.
The text was updated successfully, but these errors were encountered:
albertbori
changed the title
Make the Generated Website Indexable by Search Engines
Make DocC-Generated Website Indexable by Search Engines
Jun 4, 2024
It might be due to the large number of script requests. There are 53 total requests on the VSM iOS Documentation home page which has very little content on it.
Grouping many of those scripts into fewer calls by combining files may greatly improve the page performance and SEO. (js, CSS, etc.)
Feature Name
Search Indexable DocC Website
Description
Modify the DocC website generation tooling so that the content of each page can be indexed by all search-engines (google, bing, etc.).
Currently, the DocC-generated website doesn't support search indexing. Case in point:
The indexed content for the DocC-generated website is the
<noscript>
content, "This page requires JavaScript. Please turn on JavaScript in your browser and refresh the page to view its content."(Related to #779)
Motivation
As a user searching for documentation about an open source library whose documentation is generated with DocC and hosted on the web, I should be able to search for said documentation content on google, bing, etc. and find relevant search results, deep-linked into the specific pages of documentation.
Importance
The success of an open source project is largely dependent on its discoverability, and secondarily, it's ease of adoption. Well-hosted and discoverable documentation is a key part of ensuring this success.
Alternatives Considered
Rebuilding the website by hand saving the rendered DOM for each page and building a sitemap by hand.
The text was updated successfully, but these errors were encountered: