Repository navigation
docs: give the list a site so it reads well outside GitHub - #19
Conversation
docs/index.md is a short home block followed by an include of README.md from the `lista` section marker, so the README stays the only place entries live. The build is strict, the hook counts projects, categories and retired entries at build time, and the logo and favicon are the cider glass from the banner. The Contribuir link becomes absolute because the site has no contributing page. lychee skips the site's own URL on pull requests only, since the site does not exist until this merges.
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: GeiserX/awesome-asturies/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: ⛔ Files ignored due to path filters (2)
📒 Files selected for processing (8)
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThis change adds an MkDocs landing page for Awesome Asturies, build-time checks for its counts and rendered content, and GitHub Actions workflows to validate and publish the site. ChangesDocumentation site and publishing
Priority: ⬇️ Low Estimated code review effort: 3 (Moderate) | ~25 minutes Change: Other Merge Risk: ⚪ Minimal · up to The site retains README ownership of the list and separates pull-request validation from publishing. No actionable merge-blocking issue is established; merge after normal build checks pass. Security Architecture ReviewSecurity architecture risk: 🔵 Low · up to Pull-request builds are separated from publishing privileges, and publication requires a successful strict build. However, manual runs are not restricted to main by the workflow, so protection against publishing unmerged content depends on deployment settings that could not be verified. Retained concerns
Security review detailsSecurity Blast Radius
Security Findings and Attack Paths
Trust Boundaries and Controls
Resilience and Maintainability Implications
Hardening Proposals
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 20.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 1 files. (7 skipped: 7 unsupported.)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
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 |
The list is only readable on GitHub as one long README with a few hundred badges, and it has no search. awesome-spain and awesome-europe already have a site with search and a dark theme on top of the same README.
This gives awesome-asturies the same one-page site at https://geiserx.github.io/awesome-asturies/.
docs/index.mdis a short home block followed by an include ofREADME.mdfrom## Contenidoto the end, so the README stays the only place entries live and the lint job still governs it.What a visitor gets
README.mdandDELETED.md(37 projects, 10 categories, 8 retired today).#0f0f17) and the cider stream's yellow (#f3d27a, 13.0:1 on the sky;#946f0dfor links on the light theme, 4.6:1 on white).docs/images/logo.svg,docs/images/icon.svg).The README changes in two places. It gets the
listasection markers (HTML comments that GitHub does not render) and one sentence in the header pointing at the site. The Contribuir link tocontributing.mdbecomes absolute, because the site has no such page and the strict build fails on it otherwise.The lychee
linksjob now skipshttps://geiserx.github.io/awesome-asturies/on pull requests only, the same change awesome-catalunya carries. That URL answers 404 until this PR merges and deploys, and pushes tomainstill check it.Proof
Run on a scratch copy of this branch, with
mkdocs-material==9.7.7fromdocs/requirements-docs.txt.Planted
[planted](no-such-page.md)indocs/index.md:With the plant removed the build is back to exit 0.
awesome-lint-extra v1.1.1, with the same inputs as
main.yml:As a control, swapping Agile Asturias and Asturias Software Crafters fails it with
README.md:37 [Agile Asturias] Not in alphabetical order (should come before 'Asturias Software Crafters')(exit 1).A full-page screenshot of the local build at 1440 px wide shows the header logo, no left navigation, the table of contents, the banner, the badges, the cards and all ten categories down to the Descargo paragraph.
Deviations from the family plan
docs/mkdocs-site, notdocs/site. The site files and the README sentence are separate commits; the first one carries the README markers and the absolute link too, so each commit builds on its own.site_descriptionand the "Cómo se mantiene la lista" line say "al Principado de Asturias".c-glass, but in this banner that gradient paints the bottle, which the banner itself cuts off at its top edge; the plan's own description of the mark is the glass with the stream. The viewBox frames the lower part of the stream so it enters from the top edge. At 26 px the glass outline goes from 1.4 to 3 units, the rim from 1 to 2.5, the stream from 2.6 to 4, and the empty glass body from 0.06 to 0.14 opacity; the blurred stream glow and the 0.6 unit highlight are left out.Summary by CodeRabbit