Skip to content

[Doc] Refine README files for all examples in v1.4. #1673

Open
2 of 14 issues completed
Open
Task
2 of 14 issues completed
@joshuayao

Description

@joshuayao

Priority

P0

OS type

Ubuntu

Hardware type

Xeon-GNR

Running nodes

Single Node

Description

The request comes from the documentation task force. The goal of this refinement is to streamline the master README for each example, enhancing the user experience. Each master README will now offer a concise introduction and direct users to specific documentation paths for different aspects such as hardware, deployment, and benchmarks.

Please read the guidelines below for the refinement.
Guidelines and templates from @preethivenkatesh

Depends on the completion of #1727 .

Sub-issues

Metadata

Metadata

Labels

BacklogdocumentationImprovements or additions to documentation

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions