Repository navigation
docs: retire the docsify site, now built by brazilian-utils/docs - #627
Merged
Merged
Conversation
brazilian-utils.com.br is now the documentation of every Brazilian Utils library, built by the brazilian-utils/docs repository and served by Cloudflare Pages. It reads docs/utilities.md, docs/guides and their pt-br translations, docs/snippets and the output of scripts/examples.ts from this repository, so those stay; what only the docsify site used goes: its shells, sidebars, cover pages, styles, images, CNAME, robots.txt, scripts/site.ts, scripts/llms.ts, scripts/front-matter.ts, the build:site, build:llms and build:docs scripts, the Docs (GitHub Pages) workflow and the Vercel preview. The new site writes its own llms.txt. The Check workflow now runs build:examples instead of build:docs, so a broken example template still fails CI. Links to the old pages point to the new site (/libs/javascript/, /guides/javascript/<slug>/) or to the Markdown on GitHub, and the docsify root-relative links of the pt-br pages are now relative to their file, so they also work on GitHub. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RaUEDkvXY8rVWTJG2GKfhu
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configuration
You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
Tree-shaking report✅ No bundle size impact. All 200 exports are the same size as on the base branch (full import 1387.9 KB, gzip 293.3 KB). All exports (200)
How this is measuredEvery export is imported alone into an esbuild consumer bundle (minified, tree-shaken) built from the head and from the base of this pull request; the sizes are the resulting bundles, gzip is their gzipped size. 🔴 marks a regression: a pre-existing export that grew more than 20% and more than 256 B, or the bundle importing every pre-existing export growing more than 5%. 🟡 is growth under the threshold, 🟢 a decrease, ⚪ no change, 🆕 an export that does not exist on the base (never a regression), 🗑️ an export that was removed. An intentional increase is accepted with the |
commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #627 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 263 263
Lines 2656 2656
Branches 754 754
=========================================
Hits 2656 2656
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…e new docs site README.pt-br.md mirrors README.md and each links to the other. The doctoc table of contents is gone, and the usage section links to the guides and the migration guide on brazilian-utils.com.br. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RaUEDkvXY8rVWTJG2GKfhu
hyanmandian
force-pushed
the
hyan/remove-docs-site
branch
from
October 9, 2026 05:14
d6dcdf6 to
2fed0a3
Compare
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
1 participant
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.
Warning
Merge order. Merge only after https://brazilian-utils.com.br is served by the new site on Cloudflare Pages. Until then GitHub Pages still serves the old site, and removing
docs/CNAMEand the Pages workflow would take it down. After merging, remove the custom domain / disable GitHub Pages in the repository settings (Settings → Pages), and update the repository's "Website" field if needed.Stacked on #626 (moves the migration guide into
docs/guides/): this branch is based onhyan/migration-guide, so until #626 is merged the diff here also shows its commit. Merge #626 first.What this does
https://brazilian-utils.com.br becomes the documentation of every Brazilian Utils library, built by brazilian-utils/docs and served by Cloudflare Pages; its
_redirectsmaps the old URLs (/utilities→/libs/javascript/,/guides/<slug>→/guides/javascript/<slug>/,/migration-v1-to-v2→/guides/javascript/migration-v1-to-v2/, the/pt-brequivalents, the old.mdURLs to GitHub and/llms-full.txt→/llms.txt). This removes the docsify site of this repository and everything that only built or deployed it.Removed
docs/index.html,docs/_coverpage.md,docs/_navbar.md,docs/_sidebar.md,docs/pt-br/_coverpage.md,docs/pt-br/_sidebar.md,docs/styles.css,docs/images/(favicon and logo, used only by the shell)docs/CNAME,docs/.nojekyll,docs/robots.txt, and the.gitignoreentries of the generated shells,404.html,sitemap.xml,llms.txtandllms-full.txt(the new site writes its ownllms.txt,sitemap.xmlandrobots.txt)scripts/site.ts,scripts/llms.ts,scripts/front-matter.ts(used only by those two), and thebuild:site,build:llmsandbuild:docsnpm scripts.github/workflows/docs.yml(build and deploy to Pages) and its zizmor entry;vercel.json(the Vercel preview of the docs site); the Check workflow'sbuild:llmsandbuild:docsstepsbuild:llmsitem of the pull request template, and the docsify / llms entries ofcontext7.jsonKept, because the new site reads it (
libs/brazilian-utils-javascript.json→site.usage)docs/utilities.md,docs/pt-br/utilities.md: the reference, mapped by###symbol heading to the utility pagesdocs/guides/,docs/pt-br/guides/: the guides, with their front matter and theexample/variant/filemarkupdocs/snippets/(copied as the guides' assets, includinglive/for the demos andstyles.css)scripts/examples.tsandnpm run build:examples: the site'spreparestep; the Check workflow now runs it in place ofbuild:docs, so a broken template still fails CIdocs/getting-started.md,docs/pt-br/getting-started.md: linked from the reference, the guides, the README and CONTRIBUTING (the site turns those links into GitHub links, and its_redirectssends/getting-started.mdthere), and they hold the bundle-size table and the AI assistants section that the new site's/libs/javascript/page does not.github/workflows/preview.yml: it publishes the package to pkg.pr.new, not the docs;context7.ymlandcontext7.json: Context7 still indexesdocs/Changed
docs/snippets/styles.cssno longer imports the docsify stylesheet; on the new site the page around the demo styles it, and the import already resolved to an empty placeholder therepackage.jsonhomepage, README, SUPPORT and.bestpractices.jsonnow point to https://brazilian-utils.com.br/libs/javascript/ (and/guides/javascript/migration-v1-to-v2/); the README's "Bundle size" and "AI assistants" go todocs/getting-started.mdon GitHub; thellms-full.txtmention in getting started points to the rawutilities.mdguides/address-form.mdused docsify's docs-root-relative links (pt-br/utilities.md); they are now relative to their own file, which the new site resolves the same way and which also works on GitHubUSAGE_SOURCE=local.bestpractices.json: no binary files remain;hardened_sitenow describes Cloudflare Pages (nosniff sent, no CSP/HSTS yet, still Unmet)The CHANGELOG is not touched (no unreleased section).
Checks run locally
vp check(format, lint, types): passnpm run build:examples: passknip,jscpd: passvp test run: 274 files, 8520 tests passactionlintoncheck.yml: passcommitlint: passsite/src/lib/guides.mjsparseGuide) over this branch'sdocs/guidesanddocs/pt-br/guides: no warnings, every include found, sibling-guide links still resolve to/guides/javascript/<slug>/🤖 Generated with Claude Code
https://claude.ai/code/session_01RaUEDkvXY8rVWTJG2GKfhu