material-ui [docs][joy-ui] Enforce standard structure, style, and grammar across all docs

o4tp2gmn 于 6个月前发布在其他

关注(0)|答案(4)|浏览(55)

问题

Joy UI文档目前存在不一致的语法、风格、语调和格式。随着我们继续发展这个库并准备稳定发布，解决这种非技术债务(散文债务？😅)非常重要。
我希望逐个审查现有的每个页面，以应用我们公司的样式指南和编写文档的最佳实践。

范围

主要目标是一致性。我不关心添加新的内容，除非我们在某些需要覆盖的重要领域发现大的空白。
我打算逐个审查每个页面。大多数页面将有自己的PR,但如果编辑最小，可能会有一些被归为一组。我会根据需要进行语法、风格、页面格式、内容清晰度和完整性的编辑。
我不打算在这里对文档导航菜单进行任何重构。
这是一个大项目，所以我预计它会持续一段时间。这是我们可以跟踪进度的地方。

页面

material-ui

来源：https://github.com/mui/material-ui/issues/33998

4条答案

按热度按时间

vsaztqbk1#

感谢！@samuelsycamore。

赞(0）回复(0）举报 6个月前

nfg76nw02#

感谢@samuelsycamore,我非常感谢你对我的请求做出的全面回应！如果你有任何其他需要第二次审查的地方，请随时告诉我。

赞(0）回复(0）举报 6个月前

8dtrkrch3#

这是我计划使用的页面结构/模板：

# {{Component Name}}

## Introduction

## Basics

- import
- basic usage description and demo

## Customization

### Variants

### Sizes

### Colors

### Decorators

### etc.

## Usage with {{Other Component}}

### Details on specific usage

## Common examples

### Example 

### etc.

## Accessibility

## Anatomy

赞(0）回复(0）举报 6个月前

j5fpnvbx4#

我暂时搁置这个问题，因为核心团队将在2024年上半年将重点转移到Material UI上。

赞(0）回复(0）举报 6个月前

我来回答

material-ui [docs][joy-ui] Enforce standard structure, style, and grammar across all docs

问题

范围

页面

4条答案

相关问题

热门标签

最新问答