From 3f362b3a437ec3c2c99709c5870a6be62fbf3903 Mon Sep 17 00:00:00 2001 From: Anna Sancho Vaquer Date: Mon, 12 Jan 2026 08:42:17 +0100 Subject: [PATCH 1/9] docs: updating reference landing page ROCKS-2602 (#49) --------- Signed-off-by: Anna Sancho Vaquer Co-authored-by: Cristovao Cordeiro --- docs/reference/index.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/reference/index.md b/docs/reference/index.md index bdd96f1..7731233 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -1,10 +1,38 @@ # Reference +This section provides concise references on available commands, package slices, and security. + +## Commands + +The `chisel` command has several subcommands. + ```{toctree} :maxdepth: 1 cmd/index +``` + +## Package slices +Chisel relies on package slices. + +```{toctree} +:maxdepth: 1 + chisel-releases/index +``` +## Security +Chisel records package, slice, and file metadata to ensure file-level integrity and traceability of the slices. + +```{toctree} +:maxdepth: 1 + Manifest +``` + +Cryptographic verification ensures the integrity and authenticity of the files. + +```{toctree} +:maxdepth: 1 + Security Documentation ``` From 1a4d3cf494fa11d9b1a1d6a8ec00fb642af2b6f3 Mon Sep 17 00:00:00 2001 From: asanvaq Date: Mon, 1 Jun 2026 15:07:23 +0200 Subject: [PATCH 2/9] feat: update files for migration --- docs/_static/js/overwrite_links.js | 38 ++++++++++++++++++++++++++++++ docs/conf.py | 12 ++++++---- 2 files changed, 45 insertions(+), 5 deletions(-) create mode 100644 docs/_static/js/overwrite_links.js diff --git a/docs/_static/js/overwrite_links.js b/docs/_static/js/overwrite_links.js new file mode 100644 index 0000000..f4e0970 --- /dev/null +++ b/docs/_static/js/overwrite_links.js @@ -0,0 +1,38 @@ + // Replace oldDomain with newDomain + const oldDomain = 'documentation.ubuntu.com/chisel/en/latest/'; + const newDomain = 'ubuntu.com/chisel/docs/'; + + function escapeRegExp(value) { + return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); + } + + function overwriteMatchingAnchorUrls(container) { + if (!container) return; + + const anchors = container.querySelectorAll('a[href], link[href]'); + const oldDomainRegex = new RegExp(escapeRegExp(oldDomain), 'g'); + + anchors.forEach(anchor => { + anchor.href = anchor.href.replace(oldDomainRegex, newDomain); + }); + } + + overwriteMatchingAnchorUrls(document.querySelector('header')); + + // Use a MutationObserver to wait for the RTD flyout element to appear in the DOM + const observer = new MutationObserver(function(mutations, obs) { + + const rtdFlyout = document.querySelector('readthedocs-flyout'); + if (!rtdFlyout) return; + + obs.disconnect(); + + rtdFlyout.addEventListener('click', function() { + const shadowRoot = rtdFlyout.shadowRoot; + if (!shadowRoot) return; + + overwriteMatchingAnchorUrls(shadowRoot); + }); + }); + + observer.observe(document.body, { childList: true, subtree: true }); \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index ffbb317..92e0f33 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,7 +31,9 @@ # Sidebar documentation title; best kept reasonably short # # TODO: To include a version number, add it here (hardcoded or automated). -# + +version = f"{os.environ.get('READTHEDOCS_VERSION', 'local')}" + # TODO: To disable the title, set to an empty string. html_title = project + " documentation" @@ -70,7 +72,7 @@ # NOTE: The Open Graph Protocol (OGP) enhances page display in a social graph # and is used by social media platforms; see https://ogp.me/ -ogp_site_url = "https://documentation.ubuntu.com/chisel/" +ogp_site_url = f"https://ubuntu.com/chisel/docs//{version}/" # Preview name of the documentation website @@ -176,7 +178,7 @@ # TODO: If your documentation is hosted on https://docs.ubuntu.com/, # uncomment and update as needed. -slug = "chisel" +slug = '/docs' # Or '//docs' ####################### # Sitemap configuration: https://sphinx-sitemap.readthedocs.io/ @@ -184,7 +186,7 @@ # Use RTD canonical URL to ensure duplicate pages have a specific canonical URL -html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "/") +html_baseurl = f"https://ubuntu.com/chisel/docs//{version}/" # URL scheme. Add language and version scheme elements. # When configured with RTD variables, check for RTD environment so manual runs succeed: @@ -313,6 +315,7 @@ html_js_files = [ 'bundle.js', + "js/overwrite_links.js", ] @@ -377,4 +380,3 @@ def setup(app): app.add_css_file("tasklist.css") app.add_js_file("tasklist.js") #checkbox-enabling JS - From aaa1f1790276d34f5680427d4fdd8b1e28e57fa6 Mon Sep 17 00:00:00 2001 From: Anna Sancho Vaquer Date: Wed, 3 Jun 2026 08:46:13 +0200 Subject: [PATCH 3/9] fix: fix slug for 404 pages Signed-off-by: Anna Sancho Vaquer --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 92e0f33..7e2fe54 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -178,7 +178,7 @@ # TODO: If your documentation is hosted on https://docs.ubuntu.com/, # uncomment and update as needed. -slug = '/docs' # Or '//docs' +slug = 'chisel/docs' # Or '//docs' ####################### # Sitemap configuration: https://sphinx-sitemap.readthedocs.io/ From 175124057c2dff8e9570ae5ed76ab4f7e6aee9a7 Mon Sep 17 00:00:00 2001 From: asanvaq Date: Wed, 3 Jun 2026 09:18:59 +0200 Subject: [PATCH 4/9] feat: remove js files --- docs/_static/js/overwrite_links.js | 38 ------------------------------ 1 file changed, 38 deletions(-) delete mode 100644 docs/_static/js/overwrite_links.js diff --git a/docs/_static/js/overwrite_links.js b/docs/_static/js/overwrite_links.js deleted file mode 100644 index f4e0970..0000000 --- a/docs/_static/js/overwrite_links.js +++ /dev/null @@ -1,38 +0,0 @@ - // Replace oldDomain with newDomain - const oldDomain = 'documentation.ubuntu.com/chisel/en/latest/'; - const newDomain = 'ubuntu.com/chisel/docs/'; - - function escapeRegExp(value) { - return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); - } - - function overwriteMatchingAnchorUrls(container) { - if (!container) return; - - const anchors = container.querySelectorAll('a[href], link[href]'); - const oldDomainRegex = new RegExp(escapeRegExp(oldDomain), 'g'); - - anchors.forEach(anchor => { - anchor.href = anchor.href.replace(oldDomainRegex, newDomain); - }); - } - - overwriteMatchingAnchorUrls(document.querySelector('header')); - - // Use a MutationObserver to wait for the RTD flyout element to appear in the DOM - const observer = new MutationObserver(function(mutations, obs) { - - const rtdFlyout = document.querySelector('readthedocs-flyout'); - if (!rtdFlyout) return; - - obs.disconnect(); - - rtdFlyout.addEventListener('click', function() { - const shadowRoot = rtdFlyout.shadowRoot; - if (!shadowRoot) return; - - overwriteMatchingAnchorUrls(shadowRoot); - }); - }); - - observer.observe(document.body, { childList: true, subtree: true }); \ No newline at end of file From f4898617afc64c8cdead7359ba2a99e73d466635 Mon Sep 17 00:00:00 2001 From: asanvaq Date: Wed, 3 Jun 2026 11:17:32 +0200 Subject: [PATCH 5/9] feat: revert remove js files and update --- docs/_static/js/overwrite_links.js | 38 ++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/_static/js/overwrite_links.js diff --git a/docs/_static/js/overwrite_links.js b/docs/_static/js/overwrite_links.js new file mode 100644 index 0000000..25e0ad9 --- /dev/null +++ b/docs/_static/js/overwrite_links.js @@ -0,0 +1,38 @@ + // Replace oldDomain with newDomain + const oldDomain = 'canonical-chisel-migration.readthedocs-hosted.com'; + const newDomain = 'ubuntu.com/chisel/docs/'; + + function escapeRegExp(value) { + return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); + } + + function overwriteMatchingAnchorUrls(container) { + if (!container) return; + + const anchors = container.querySelectorAll('a[href], link[href]'); + const oldDomainRegex = new RegExp(escapeRegExp(oldDomain), 'g'); + + anchors.forEach(anchor => { + anchor.href = anchor.href.replace(oldDomainRegex, newDomain); + }); + } + + overwriteMatchingAnchorUrls(document.querySelector('header')); + + // Use a MutationObserver to wait for the RTD flyout element to appear in the DOM + const observer = new MutationObserver(function(mutations, obs) { + + const rtdFlyout = document.querySelector('readthedocs-flyout'); + if (!rtdFlyout) return; + + obs.disconnect(); + + rtdFlyout.addEventListener('click', function() { + const shadowRoot = rtdFlyout.shadowRoot; + if (!shadowRoot) return; + + overwriteMatchingAnchorUrls(shadowRoot); + }); + }); + + observer.observe(document.body, { childList: true, subtree: true }); \ No newline at end of file From cb2d572738e1bfabdeba581ef3f9b2700a43d0d9 Mon Sep 17 00:00:00 2001 From: asanvaq Date: Fri, 5 Jun 2026 09:42:10 +0200 Subject: [PATCH 6/9] fix: update based on comments --- docs/conf.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 7e2fe54..9ad6580 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -72,7 +72,7 @@ # NOTE: The Open Graph Protocol (OGP) enhances page display in a social graph # and is used by social media platforms; see https://ogp.me/ -ogp_site_url = f"https://ubuntu.com/chisel/docs//{version}/" +ogp_site_url = f"https://ubuntu.com/chisel/docs/{version}/" # Preview name of the documentation website @@ -186,7 +186,7 @@ # Use RTD canonical URL to ensure duplicate pages have a specific canonical URL -html_baseurl = f"https://ubuntu.com/chisel/docs//{version}/" +html_baseurl = f"https://ubuntu.com/chisel/docs/{version}/" # URL scheme. Add language and version scheme elements. # When configured with RTD variables, check for RTD environment so manual runs succeed: @@ -200,6 +200,7 @@ # Include `lastmod` dates in the sitemap: sitemap_show_lastmod = True +sitemap_filename = "doc-sitemap.xml" # Exclude generated pages from the sitemap: From 0eacdf37e187bd3fbaa42a33f7907af07d99f8ce Mon Sep 17 00:00:00 2001 From: asanvaq Date: Fri, 5 Jun 2026 09:47:45 +0200 Subject: [PATCH 7/9] fix: update js linlks --- docs/_static/js/overwrite_links.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_static/js/overwrite_links.js b/docs/_static/js/overwrite_links.js index 25e0ad9..3177fc0 100644 --- a/docs/_static/js/overwrite_links.js +++ b/docs/_static/js/overwrite_links.js @@ -1,6 +1,6 @@ // Replace oldDomain with newDomain - const oldDomain = 'canonical-chisel-migration.readthedocs-hosted.com'; - const newDomain = 'ubuntu.com/chisel/docs/'; + const oldDomain = '<>'; + const newDomain = 'ubuntu.com/chisel/docs'; function escapeRegExp(value) { return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); From 3dcc27c40b630939ad42ef83e67548b5c2ed6a7a Mon Sep 17 00:00:00 2001 From: asanvaq Date: Fri, 5 Jun 2026 10:15:57 +0200 Subject: [PATCH 8/9] fix: fix sitemap config --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 9ad6580..5274c08 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -193,7 +193,7 @@ if 'READTHEDOCS_VERSION' in os.environ: version = os.environ["READTHEDOCS_VERSION"] - sitemap_url_scheme = '{version}{link}' + sitemap_url_scheme = '{link}' else: sitemap_url_scheme = 'MANUAL/{link}' From 291d5c3ee63f42bfa60f34ef408739029390e8b4 Mon Sep 17 00:00:00 2001 From: Anna Sancho Vaquer Date: Mon, 8 Jun 2026 08:22:11 +0200 Subject: [PATCH 9/9] fix: update rtd links based on merge proposal review Signed-off-by: Anna Sancho Vaquer --- docs/_static/js/overwrite_links.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_static/js/overwrite_links.js b/docs/_static/js/overwrite_links.js index 3177fc0..3eb9fc6 100644 --- a/docs/_static/js/overwrite_links.js +++ b/docs/_static/js/overwrite_links.js @@ -1,5 +1,5 @@ // Replace oldDomain with newDomain - const oldDomain = '<>'; + const oldDomain = 'canonical-chisel-migration.readthedocs-hosted.com'; const newDomain = 'ubuntu.com/chisel/docs'; function escapeRegExp(value) { @@ -35,4 +35,4 @@ }); }); - observer.observe(document.body, { childList: true, subtree: true }); \ No newline at end of file + observer.observe(document.body, { childList: true, subtree: true });