Skip to content

feat: upgrade OINK to 1.2.0 and improve docs UX - #514

Merged
imbajin merged 14 commits into
apache:masterfrom
hugegraph:docs/oink-1.2.0
Oct 11, 2026
Merged

feat: upgrade OINK to 1.2.0 and improve docs UX#514
imbajin merged 14 commits into
apache:masterfrom
hugegraph:docs/oink-1.2.0

Conversation

@imbajin

@imbajin imbajin commented Oct 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Version upgrade

Dependency Before After
OINK Hugo module 1.1.0 Pinned 1.2.0, using native components and public customization hooks

Public routes, language switching and historical documentation stay compatible.

Bug fixes

Problem Result
Module checks could use development imports or change lock files Check an isolated production module graph without modifying the site's locks
Upgrade previews could omit current working-tree content Validate the actual content being reviewed and retain recovery reports
Supported chart/recording configurations could escape or fail safety checks Validate native configuration variants and their HTML, CSS, image and navigation inputs
Tooltip shorthand, inherited fonts and fallback colors bypassed checks Check the values used by the actual tooltip model while preserving ordinary dataset text
Enabled Markmap could load unchecked resources Limit published maps to text outlines and code, with the existing safe layout parameter
Technical tables squeezed parameter names or descriptions Preserve readable columns and native horizontal scrolling; the PD fix applies only to its wide environment table
FileTree truncated long definitions unless hovered Wrap complete annotations and retain keyboard folding and column resizing
Markmap text was too dark in dark mode Follow the theme's body text color
Chart tooltips and the fixed taxonomy rail overlapped surrounding UI Keep tooltips within charts and the right rail above the visible footer
Sidebar icons and homepage controls were inconsistent Use explicit native icons, equal-width homepage buttons and white button text/icons in both color modes
The Chinese listener example displayed Markdown fence markers Restore a valid fenced block and global line numbers
Small commands were unnecessarily folded and long examples were hard to read Keep short blocks visible; show nine lines of long scripts and copy the complete source

Enabled features

Feature Where it is used
Native appearance controls Paper/Slate styles with independent light/dark selection
Blog covers, categories, tags and ordered series HugeGraph blog cards and the ToplingDB articles, with subtle article backgrounds
FileTree Annotated RocksDB data directories
Cards and Steps Server deployment choices and genuinely sequential setup workflows
ECharts Historical benchmark visualization alongside the original table and test conditions
Gallery and image zoom Hubble screenshot overview, retaining the detailed operation sections
Markmap Collapsible Server component outline
Native callouts, keyboard labels and math Prerequisites, physical shortcuts and the existing Jaccard definition
Global code line numbers Standard Markdown language fences, without custom code titles
Optional terminal recording A folded contribution example showing real toolchain checks, with copyable commands retained

Validation covers strict builds, links, security, bilingual desktop/mobile interactions, search and historical navigation. AI remains consent-gated.

@imbajin
feat: upgrade OINK and improve documentation UX
71c049c 
- adopt native bilingual blog and documentation components
- integrate OINK 1.2 appearance and navigation contracts
- harden theme upgrade snapshots and component security checks
- verify browser interactions and desktop/mobile layouts
@imbajin
fix: constrain native recording configuration
326fe13 
- match the pinned OINK shortcode configuration schema
- reject unsupported audio and driver resource options
- validate native poster and marker types with regressions
@imbajin
fix: wait for chart rendering before capture
93d28c4 
- wait for the native ECharts renderer to finish
- preserve chart animations and original performance data
- verify final column heights in both language captures
imbajin
imbajin commented Oct 11, 2026
View reviewed changes

@imbajin imbajin left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Blocking: yes. Summary: The ECharts resource guard misses CSS in chart options, and the Asciinema marker validator rejects OINK's serialized format. Evidence: OINK v1.2.0 source and bundled ECharts behavior; exact-head workflow 38129864788 passed.

Comment thread dist/validate-site-output.py Outdated
Comment thread dist/validate-site-output.py Outdated
imbajin added 11 commits October 11, 2026 23:05
@imbajin
fix: address OINK review findings
b2d2205 
- isolate release themes and validate root module imports
- validate native component sinks and marker structures
- align master startup flow and improve mobile dark maps
- keep terminal recording optional and document authoring
@imbajin
fix: align sidebar icons across sections
5f928f0 
- show explicitly configured icons on leaf sections
- add bilingual about and component section icons
- verify icon slots and label alignment in both languages
@imbajin
docs: clarify terminal recording dimensions
a42d43e 
- use the current terminal size in the recording command
- explain resizing before recording
- distinguish player cropping from recording dimensions
@imbajin
fix: replace the default blog cover
a10ea20 
- use the supplied HugeGraph and Apache artwork
- remove the generated cover and update bilingual defaults
- align historical assets and image validation
@imbajin
fix: equalize homepage action buttons
e4fc926 
- use equal grid columns for homepage actions
- retain compact desktop sizing
- constrain mobile actions to the available width
@imbajin
fix: keep configuration tables readable
f7c8f39 
- preserve technical table identifiers on desktop
- add bilingual parameter layout and scrolling checks
- label the RocksDB configuration and show line numbers
@imbajin
fix: preserve readonly checks and chart tooltips
820c866 
- isolate Hugo graph lock writes from the checkout
- confine chart tooltips with bilingual touch checks
- disable animations in navigation evidence captures
@imbajin
fix: validate native chart option variants
6b33f27 
- cover effective option roots and active image resources
- validate actual tooltip HTML and CSS colour sources
- document unsupported colour callbacks and retain inert data
@imbajin
fix: enable native global code line numbers
673db02 
Enable global inline numbers with native lexer fallback.\nRemove ordinary code titles and normalize language fences.\nKeep the taxonomy rail above the footer and verify both locales.
@imbajin
fix: harden upgrades and native component UX
1d82fcf 
- Verify the isolated production module graph.
- Check tooltip inputs and restrict Markmap resources.
- Keep FileTree notes and PD tables readable.
- Preserve white home button text in dark mode.
@imbajin
fix: render the listener example as a fence
dbb653f 
- Remove the top-level indentation in the Chinese guide.
- Preserve the valid English list example.
- Guard native line numbers and exclude fence markers.
@imbajin
imbajin merged commit 6181c87 into apache:master Oct 11, 2026
5 checks passed
@imbajin imbajin mentioned this pull request Oct 11, 2026
Open
26 of 82 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Pengzna Pengzna Pengzna approved these changes
@MrJs133 MrJs133 MrJs133 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@imbajin @Pengzna @MrJs133