Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enhancement] kcl doc gen: optimize the document format and styles #157

Closed
3 tasks done
amyXia1994 opened this issue Sep 12, 2023 · 0 comments
Closed
3 tasks done
Labels
good first issue Good for newcomers help wanted Extra attention is needed tool

Comments

@amyXia1994
Copy link
Contributor

amyXia1994 commented Sep 12, 2023

Enhancement

parent issue: #139

This issue is raised according to catalog doc sync PR:

https://kusionstack.io/docs/reference/model/catalog_models/internal/container/doc_container

The model docs on the official website have been manually modified and are more more clear and human-friendly than the documents generated directly by the kcl-doc tool.

The doc gen spec and templates should be optimized accordingly.

cc @ffforest

@amyXia1994 amyXia1994 self-assigned this Sep 12, 2023
@amyXia1994 amyXia1994 changed the title kcl doc gen: [Enhancement] kcl doc gen: optimize the document format and styles Sep 12, 2023
@Peefy Peefy added this to KCL 2023 Sep 18, 2023
@Peefy Peefy moved this to Backlog in KCL 2023 Sep 18, 2023
@Peefy Peefy moved this from Backlog to In Progress in KCL 2023 Sep 18, 2023
@Peefy Peefy added the tool label Sep 18, 2023
@Peefy Peefy moved this from In Progress to 2023.10 Iteration In Progress in KCL 2023 Oct 9, 2023
@amyXia1994 amyXia1994 moved this from 2023.10 Iteration In Progress to 2023.10 Iteration Done in KCL 2023 Oct 30, 2023
@Peefy Peefy assigned zong-zhe and unassigned amyXia1994 Dec 10, 2023
@Peefy Peefy added help wanted Extra attention is needed good first issue Good for newcomers labels Jan 24, 2024
@Peefy Peefy closed this as completed Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed tool
Projects
No open projects
Status: 2023.10 Iteration Done
Development

No branches or pull requests

3 participants