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

Make DocC-Generated Website Indexable by Search Engines #939

Open
albertbori opened this issue Jun 4, 2024 · 2 comments
Open

Make DocC-Generated Website Indexable by Search Engines #939

albertbori opened this issue Jun 4, 2024 · 2 comments
Labels
enhancement Improvements or enhancements to existing functionality

Comments

@albertbori
Copy link

albertbori commented Jun 4, 2024

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:
image

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.

@albertbori albertbori added the enhancement Improvements or enhancements to existing functionality label Jun 4, 2024
@albertbori albertbori changed the title Make the Generated Website Indexable by Search Engines Make DocC-Generated Website Indexable by Search Engines Jun 4, 2024
@louwers
Copy link

louwers commented Jun 21, 2024

Google indexes websites that require JavaScript. At least our docs seem to pop up on Google:

image

But SEO can probably be improved.

@albertbori
Copy link
Author

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.)

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements or enhancements to existing functionality
Projects
None yet
Development

No branches or pull requests

2 participants