Skip to content

feat: create documentation website #1753

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

Closed
RSS1102 opened this issue Oct 3, 2022 · 4 comments
Closed

feat: create documentation website #1753

RSS1102 opened this issue Oct 3, 2022 · 4 comments
Labels
status: superset by another Issue or task being tracked/handled in a different issue. type: feature Issues related to new features.

Comments

@RSS1102
Copy link

RSS1102 commented Oct 3, 2022

Description

READ. ME The me is too difficult to read, and it is difficult for maintainers to track and change problems in time.

Proposed solution

I think each module can be maintained in multiple. md files. Then the document website is automatically generated by ci operation . md file.There are many, many mature libraries that can be operated in this way, such as: vitepress . (There may be better tools).


I see that great defenders seem to be experiencing some problems in life, so this is just my suggestion and hope. (By the way, if you need me to do this work, you can remind me that I will try it [although I have not actually performed the actual code operation in this area])

@RSS1102 RSS1102 added flag: needs discussion Issues which needs discussion before implementation. type: feature Issues related to new features. labels Oct 3, 2022
@braaar
Copy link
Member

braaar commented Oct 4, 2022

I think this is a nice idea. The TypeStack org has a documentation website for TypeDI using GitBook. Is that worth a look?

Here is the source for that website. Seems simple enough to me

@RSS1102
Copy link
Author

RSS1102 commented Oct 4, 2022

yeah,this's look like good.same as my think(Although the style is not so beautiful i think).

@braaar
Copy link
Member

braaar commented Oct 6, 2022

This is already a part of the roadmap, I realise #178

@RSS1102 RSS1102 closed this as completed Oct 6, 2022
@github-actions
Copy link

github-actions bot commented Nov 6, 2022

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 6, 2022
@NoNameProvided NoNameProvided removed the flag: needs discussion Issues which needs discussion before implementation. label Nov 21, 2022
@NoNameProvided NoNameProvided changed the title feature: I think need to build a document site . feat: create documentation website Nov 21, 2022
@NoNameProvided NoNameProvided added the status: superset by another Issue or task being tracked/handled in a different issue. label Nov 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: superset by another Issue or task being tracked/handled in a different issue. type: feature Issues related to new features.
Development

No branches or pull requests

3 participants