ITADN

docs: Add clickable links to docs-site, protocol specs, and NatSpec viewer in README

#21618OpenCripto5588 创建于 2026-05-01
C
Cripto5588commented
While reviewing the main README.md of the taiko-mono repository, I noticed that the "Documentation" section lists essential resources only as descriptive text, without clickable hyperlinks or explicit relative paths within the monorepo. Objective Evidence Current excerpt (README.md, lines 10–18): ## Documentation Get started with Taiko Alethia: - Taiko Alethia docs — High-level concepts, guides, resources, and reference pages for getting started (source: taiko-docs). - Protocol specs — In-depth specifications of the Taiko Alethia protocol for deeper understanding. - Smart contracts — Taiko Alethia protocol smart contracts, fully documented with NatSpec. None of the above items contain: - direct hyperlinks to external documentation - relative paths within the repository - navigable references for immediate location of the cited resources Observed Impact - Indirect navigation: Developers need to manually locate the mentioned resources within a monorepo with multiple packages - Increased onboarding time: The absence of clickable links hinders initial access to essential documentation - Limited discovery: Identifying specs and relevant documentation depends on manual exploration of the repository Question for maintainers Do you consider that the absence of explicit hyperlinks and paths in the "Documentation" section of the README negatively impacts the accessibility of the documentation for external developers?
1 条评论