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.

Sign up for GitHub

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

Jump to bottom

feat: rebuild tutorial #5

Merged
merged 3 commits into from
Dec 9, 2023
Merged

feat: rebuild tutorial #5

merged 3 commits into from
Dec 9, 2023

Conversation

Mister-Hope
Copy link
Contributor

No description provided.

@Mister-Hope
Copy link
Contributor Author

After:

image

@Mister-Hope
Copy link
Contributor Author

Mister-Hope commented Dec 6, 2023 •
edited
Loading

I may not push further contribution here because limited time. Just have some interest in this project and finding a POOR tutorial.

Some personal suggestions here:

  1. Use clean and short descriptions in docs

    image

    image

  2. Could use tab feature for different env in other pages

  3. Use tip, note, info, warning, danger container to mark important things.

  4. Use Clear nad meaningful text as link text:

    - For feature ABC, please refer [here](xxx)
+ Further details can be found at [feature ABC](xxx)

Mister-Hope
Mister-Hope commented Dec 6, 2023
View reviewed changes
src/tutorial/README.md Outdated Show resolved Hide resolved
@alexliyu7352 alexliyu7352 merged commit 69418df into ZLMediaKit:main Dec 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
EnglishNative
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Mister-Hope @alexliyu7352