feat: add SEO metadata for documentation#27
Merged
pFornagiel merged 11 commits intomainfrom Mar 19, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds SEO-oriented metadata to the MkDocs documentation site and to the package distribution metadata to improve discoverability for both search engines and PyPI.
Changes:
- Adds MkDocs Material template override to inject JSON-LD structured data into page headers.
- Adds per-page
descriptionmetadata to documentation Markdown pages. - Expands
pyproject.tomlproject metadata (authors/license/URLs/keywords/classifiers).
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Adds richer PEP 621 project metadata (authors/license/URLs/keywords/classifiers). |
| mkdocs.yml | Enables MkDocs Material template overrides via custom_dir. |
| docs/overrides/main.html | Injects JSON-LD structured data through a theme override. |
| docs/index.md | Adds page description frontmatter for the docs homepage. |
| docs/getting-started/installation.md | Adds page description frontmatter. |
| docs/getting-started/quickstart.md | Adds page description frontmatter. |
| docs/getting-started/concepts.md | Adds page description frontmatter. |
| docs/api/index.md | Adds page description frontmatter for API overview. |
| docs/user-guide/sampling.md | Adds page description frontmatter for sampling guide. |
| docs/user-guide/analysis.md | Adds page description frontmatter for analysis guide. |
| docs/user-guide/visualization.md | Adds page description frontmatter for visualization guide. |
| docs/user-guide/examples.md | Adds page description frontmatter for examples page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,25 @@ | |||
| {% extends "base.html" %} | |||
|
|
|||
| {% block extrahead %} | |||
Collaborator
Author
There was a problem hiding this comment.
This is not an issue really, as the material theme we are using does not have anything defined in its extrahead block, source code for refernce
In case that I am missing some greater context, still implemented in f054e43 as this should not break anything.
| "url": "https://github.com/helix-agh" | ||
| }, | ||
| "downloadUrl": "https://pypi.org/project/lonkit/", | ||
| "softwareVersion": "0.1.0", |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds SEO metadata to improve search engine discoverability of the lonkit documentation. The changes include JSON-LD, frontmatter descriptions for documentation pages, and updated project metadata in
pyproject.toml.Changes Made
Added JSON-LD structured data (
docs/overrides/main.html) andcustom_dir: docs/overridesto enable the HTML template override inmkdocs.ymlfor itAdded
custom_dir: docs/overridesto enable the HTML template override inmkdocs.ymlAdded frontmatter
descriptionto markdown documentation pagesIn
pyproject.toml:Apart from changes above, it may also be worth considering whether we want to use the Google Search Console for better docs indexing, as described here.