From 6a9a783ad38efb897568ffcc59878eae15d17136 Mon Sep 17 00:00:00 2001 From: Xi Xu Date: Fri, 6 Jun 2025 18:55:00 +0800 Subject: [PATCH] Update documentation workflow and 404 page Added a new 404.md file for handling 'Page Not Found' errors in the documentation. Updated the publish_docs.yml workflow to include a 'cname' parameter. Removed the CNAME file from the docs directory as it is now managed in the workflow. --- .github/workflows/publish_docs.yml | 1 + docs/404.md | 68 ++++++++++++++++++++++++++++++ docs/CNAME | 1 - 3 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 docs/404.md delete mode 100644 docs/CNAME diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml index 29b1edc..c688b70 100644 --- a/.github/workflows/publish_docs.yml +++ b/.github/workflows/publish_docs.yml @@ -64,6 +64,7 @@ jobs: user_name: "github-actions[bot]" user_email: "github-actions[bot]@users.noreply.github.com" commit_message: "Deploy documentation from ${{ github.sha }}" + cname: tzst.xi-xu.me docs-quality-check: runs-on: ubuntu-latest diff --git a/docs/404.md b/docs/404.md new file mode 100644 index 0000000..24368b0 --- /dev/null +++ b/docs/404.md @@ -0,0 +1,68 @@ +--- +myst: + html_meta: + description: "Page not found - tzst documentation. Return to the main documentation or search for what you're looking for." + keywords: "404, page not found, tzst documentation, error" + og:title: "Page Not Found - tzst Documentation" + og:description: "The requested page could not be found. Visit the tzst documentation homepage or use the search feature." + twitter:title: "Page Not Found - tzst Documentation" + twitter:description: "The requested page could not be found. Visit the tzst documentation homepage or use the search feature." +--- + +# 404 - Page Not Found + +## 🔍 Oops! The page you're looking for doesn't exist + +The URL you requested could not be found in the tzst documentation. This might happen if: + +- The page has been moved or renamed +- You followed a broken link +- There's a typo in the URL +- The page has been removed + +## 🏠 Where would you like to go? + +### Popular Pages + +- **{doc}`index`** - Documentation homepage +- **{doc}`quickstart`** - Get started with tzst +- **{doc}`examples`** - Practical examples and use cases +- **{doc}`api/index`** - Complete API reference + +### Quick Navigation + +- **Installation Guide** - {ref}`quickstart:installation` +- **Basic Usage** - {ref}`quickstart:basic-usage` +- **Security Features** - {ref}`examples:security-and-filtering` +- **Error Handling** - {ref}`examples:error-handling` + +## 🔎 Search Documentation + +Use the search box in the top navigation to find what you're looking for, or browse through these sections: + +### Core Features + +- **{doc}`api/core`** - Core TzstArchive class and functions +- **{doc}`api/cli`** - Command-line interface +- **{doc}`api/exceptions`** - Exception handling + +### Examples & Tutorials + +- **Archive Creation** - {ref}`examples:basic-archive-operations` +- **Security Best Practices** - {ref}`examples:security-and-filtering` +- **Integration Examples** - {ref}`examples:integration-examples` +- **Performance Optimization** - {ref}`quickstart:performance-optimization` + +## 📚 Additional Resources + +- [GitHub Repository](https://github.com/xixu-me/tzst) - Source code and issue tracker +- [PyPI Package](https://pypi.org/project/tzst/) - Download and installation +- [Release Notes](https://github.com/xixu-me/tzst/releases) - Latest updates and changes + +## 🐛 Report an Issue + +If you believe this is a broken link within our documentation, please [report it on GitHub](https://github.com/xixu-me/tzst/issues). + +--- + +**Need help?** Check our {doc}`quickstart` guide or browse the {doc}`examples` for common use cases. diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index 9739d17..0000000 --- a/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -tzst.xi-xu.me