> ## Documentation Index
> Fetch the complete documentation index at: https://harisfazillah.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# How-To: Generate SEO Assets and Sitemaps

> This guide explains how to compile search engine optimisation (SEO) assets, text listings, standard XML structures, and crawlers rules.

This guide explains how to compile search engine optimisation (SEO) assets, text listings, standard XML structures, and crawlers rules.

## Prerequisites

* **Python 3.12+** and **`uv`** installed.
* Valid `SUMMARY.md` file registered at the repository root.

## Step 1: Run sitemap compilation

Run the sitemap script from the repository root. This command builds the static site, crawls local files, translates GitBook paths, and saves outputs:

```bash theme={null}
uv run --with mkdocs-material python tools/generate_sitemaps.py

```

## Step 2: Confirm generated assets

Verify that sitemap files have been populated under three distinct paths: root directory `./`, `docs/`, and `site/`.

### Check plaintext URL indices

```bash theme={null}
head -n 5 sitemap.txt

```

### Check XML structure

```bash theme={null}
head -n 10 sitemap.xml

```

## Step 3: Run regression validation

Execute standard unit test suites to confirm correctness of derived Read the Docs links and GitBook canonical formats:

```bash theme={null}
uv run --with pyyaml --with pytest pytest tests/test_seo_sitemaps.py tests/test_sitemap_seo_generator_skill.py

```

***

*Deep State of Mind (DSOM) For My AI Protocol | Harisfazillah Jamel (LinuxMalaysia) | 2026-08-14*
*Standard: UK English | DBP-standard Bahasa Melayu Malaysia (Piawai) | GNU General Public License v3.0*


## Related topics

- [🗺️ Sitemap & SEO Asset Generator Skill](/skills/sitemap-seo-generator.md)
- [Reference: generate_sitemaps.py](/reference/generate_sitemaps.md)
- [How-To Guides Index](/how-to/index.md)
- [Google Jules & Google Antigravity Collaborative Sync](/skills/jules-antigravity-sync.md)
- [How-To: Verify and Monitor Site with Google Search Console](/how-to/google-search-console.md)