关于文档的一点小建议
Open
document
- Dominant language
- JavaScript
- Stars
- 2.7k
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
目前,中文文档大部分内容来自eggjs,beidou的同构部分很少,需要自己去看例子。
比如` router: {
root: 'pages',
urlPrefix: '/static',
},
`这个是做什么的,我在文档中好像没找到说明,对于新手来说,不是很友好。
希望,可以想nextjs一样,文档结合例子的形式,降低入门门槛。
另外,是否可以用gitbook架设一个专门的文档页面,在github中读文档体验不好。
Contributor guide
Research direction
Start by reviewing the existing Chinese documentation and examples, focusing on the documented behavior of the router configuration. Done would require adding beginner-friendly explanations and examples for missing Beidou-specific features, with any documentation-site decision clarified first.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100