Skip to content

docs: update overall doc style#127

Merged
adohe merged 1 commit into
mainfrom
feat/update-docs-style
Jul 2, 2026
Merged

docs: update overall doc style#127
adohe merged 1 commit into
mainfrom
feat/update-docs-style

Conversation

@adohe

@adohe adohe commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Update the overall documentation site style, to keep it more clean and technical.

Related issue

#106

Type of change

  • 🐛 Bug fix
  • ✨ New feature
  • 💥 Breaking change (public API / CLI behavior changes in a non-backward-compatible way)
  • 📝 Documentation update
  • ♻️ Refactoring
  • ⚡ Performance improvement
  • ✅ Test coverage improvement

How was it tested?

Checklist

  • The PR title summarizes the contribution.
  • Linked the related issue in the description (if any).
  • Existing tests pass (pytest tests/ -k cpu).
  • New behavior is covered by tests.
  • Described the test commands run and any hardware limitations.
  • Public API / CLI changes are additive and backward-compatible (see CONTRIBUTING.md).

Breaking change details

@adohe adohe added this to the v0.0.4 milestone Jul 1, 2026
@adohe adohe self-assigned this Jul 1, 2026
@adohe adohe added kind/documentation Categorizes issue or PR as related to documentation area/dx Issues or PRs related to developer experience (error messages, ergonomics, onboarding) labels Jul 1, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation layout and styling for AReno. It introduces a major CSS redesign, custom HTML layout components on the landing page, new templates for the header and sidebar, and updates to the Sphinx configuration. The reviewer feedback focuses on improving the readability of the .rst source by replacing HTML entity newlines with standard newlines in code blocks, adding double quotes to HTML attributes, wrapping hardcoded UI strings in translation functions for internationalization, and adding vendor prefixes and properties for better cross-browser CSS compatibility.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/index.rst Outdated
Comment thread docs/index.rst Outdated
Comment thread docs/index.rst Outdated
Comment thread docs/index.rst Outdated
Comment thread docs/index.rst Outdated
Comment thread docs/_templates/partials/site-head.html Outdated
Comment thread docs/_templates/partials/site-head.html Outdated
Comment thread docs/_static/areno.css
Comment thread docs/_static/areno.css
Comment thread docs/_static/areno.css

@xsuler xsuler left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

重构文档站点的整体样式、首页布局、侧边栏、主题切换和 AReno 品牌资源,使 Sphinx 文档站点更接近目标的简洁技术文档风格。

同时根据 PR 评审反馈清理 raw HTML 代码块换行、修正模板属性与 i18n 文案,并补充跨浏览器 CSS 兼容性前缀。
@adohe adohe force-pushed the feat/update-docs-style branch from 0bf1a6c to 4a72803 Compare July 2, 2026 02:56
@adohe adohe merged commit cec61a3 into main Jul 2, 2026
2 checks passed
@adohe adohe deleted the feat/update-docs-style branch July 3, 2026 06:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/dx Issues or PRs related to developer experience (error messages, ergonomics, onboarding) kind/documentation Categorizes issue or PR as related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants