Skip to content

Commit 1ba4084

Browse files
authored
docs: move issue pages into docs/issues/ and add explainers section to README (#109)
- Restructure: docs/issue-105.html → docs/issues/issue-105.html - Remove stale docs/ocr_training_pipeline.html - Update index.html links to issues/ subdirectory - Add Interactive Explainers section to README with hub + issue table
1 parent 66b3588 commit 1ba4084

4 files changed

Lines changed: 17 additions & 936 deletions

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
- [Related Projects](#-related-projects)
3939
- [Citation](#-citation)
4040
- [License](#-license)
41-
- [Documentation](#-documentation)
41+
- [Interactive Explainers](#-interactive-explainers)
4242

4343
---
4444

@@ -485,6 +485,20 @@ For detailed usage, see the [LLaVA-Next README](llava_next/README.md).
485485

486486
---
487487

488+
## 📖 Interactive Explainers
489+
490+
We publish interactive visual explainers for frequently asked questions. Each issue gets a dedicated page with animations, code references, and CN/EN bilingual support.
491+
492+
🔗 **[Hub Page](https://evolvinglmms-lab.github.io/OneVision-Encoder/)**
493+
494+
| Issue | Topic | Page |
495+
|-------|-------|------|
496+
| [#105](https://github.com/EvolvingLMMs-Lab/OneVision-Encoder/issues/105) | How OCR annotations are used during training | [issue-105.html](https://evolvinglmms-lab.github.io/OneVision-Encoder/issues/issue-105.html) |
497+
498+
This table will be updated as more explainers are added. If you have a question that would benefit from a visual explanation, feel free to [open an issue](https://github.com/EvolvingLMMs-Lab/OneVision-Encoder/issues/new).
499+
500+
---
501+
488502
## 👥 Contributors
489503

490504
<table>

docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h1><span class="lang-span" data-en="Issue Explainers" data-zh="Issue 详解">Is
121121

122122
<div class="issue-list">
123123

124-
<a class="issue-card" href="issue-105.html">
124+
<a class="issue-card" href="issues/issue-105.html">
125125
<div class="issue-tag open">#105</div>
126126
<div class="issue-title">
127127
<span class="lang-span"
@@ -143,7 +143,7 @@ <h1><span class="lang-span" data-en="Issue Explainers" data-zh="Issue 详解">Is
143143
</a>
144144

145145
<!-- Add more issue cards here following the same pattern:
146-
<a class="issue-card" href="issue-XXX.html">
146+
<a class="issue-card" href="issues/issue-XXX.html">
147147
<div class="issue-tag open">#XXX</div>
148148
<div class="issue-title">
149149
<span class="lang-span" data-en="..." data-zh="...">...</span>

0 commit comments

Comments
 (0)