docs(useBodyScrollLock): align English and plugin docs with Korean docs - #489
docs(useBodyScrollLock): align English and plugin docs with Korean docs#489Antoliny0919 wants to merge 1 commit into
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #489 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 69 69
Lines 2280 2280
Branches 737 737
=========================================
Hits 2280 2280 🚀 New features to boost your workflow:
|
|
Hello Hello 👋 It looks like CI is failing because the JSDoc and the documentation don’t match. Does this mean the intention is for JSDoc and the documentation to contain exactly the same content? I feel that while they serve similar purposes, they may need different levels of detail. JSDoc should focus on the essential interface information someone needs when using an API, while the documentation can include more examples and caveats alongside that information, as it does now. From that perspective, the tight coupling between JSDoc and the documentation feels limiting, especially in situations like this. If we can’t manage the documentation independently, adding more detailed explanations could cause problems. Personally, I’m not sure automatic documentation generation is essential. For a library like react-simplikit, which provides relatively simple hooks and functions, keeping JSDoc and the documentation aligned may be feasible. But that also means there isn’t a large amount of documentation to maintain, so managing it manually may not be particularly costly either. Perhaps the core question isn’t whether we should generate documentation automatically, but whether JSDoc and the documentation should contain exactly the same content. The generation process can become a problem when it enforces that requirement. For example, if we update the English documentation now and run the generator afterward, those changes will be overwritten by the content from JSDoc. This suggests it may be worth reconsidering the scope of automatic generation. I’d appreciate the chance to discuss these broader questions about how we manage documentation together 👍 |
2 participants
Overview
The Korean and English documentation for
useBodyScrollLockdiffer in content and should be aligned for consistency.The Korean documentation also seems more relevant and informative, particularly with examples such as using multiple modals.