Enhance documentation with mascot branding and Material icons - #16
Open
krypton-byte wants to merge 6 commits into
Open
Enhance documentation with mascot branding and Material icons#16krypton-byte wants to merge 6 commits into
krypton-byte wants to merge 6 commits into
Conversation
- Add mascot.png as logo and favicon in mkdocs.yml - Copy mascot.png to docs/assets/ for Zensical builds - Add Material Design icons to all 27 documentation page headings (installation, quickstart, architecture, API reference, tutorials, operations, reference sections) - Add mascot.png to README.md header across all language variants - Add mascot image to docs/index.md landing page
Update submodule from 1489b7da to ed543cba (21 commits) including VoIP optimizations, media performance improvements, and dependency bumps. Adapt code to breaking changes: hangup→hangup_local, set_muted now async. Update Cargo.lock to resolve libsqlite3-sys 0.37→0.38 conflict.
… shortcodes MkDocs nav section doesn't process markdown extensions like pymdownx.emoji, so :material-*: shortcodes were rendered as plain text. Switch to the supported approach: icon front matter in section index.md pages with navigation.indexes feature enabled.
Embed Context7 widget on all documentation pages to provide developers with version-specific, up-to-date documentation and code examples directly from the source.
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.
This pull request introduces several improvements to project documentation and CI configuration. The main changes include enhanced visual branding in the documentation, improved navigation with icons, and simplification of CI workflow caching steps.
Documentation improvements:
README.md,README.id.md, andREADME.zh.mdfiles for better visual branding. [1] [2] [3] [4]docs/core-concepts/index.md,docs/getting-started/index.md, anddocs/api/index.mdfor improved structure and discoverability. [1] [2] [3]CI workflow simplification:
.github/workflows/CI.ymland.github/workflows/pr-check.ymlby removing redundant workspace-specific cache entries. [1] [2]Other project configuration:
.github/FUNDING.yml.## SummaryType of Change
Checklist
type(scope): summary)ruff, formatting, stub parity)Linked Issues
Notes for Reviewer