Skip to content

docs(mkdocs): clean content and add short demo#45

Merged
benbenbang merged 1 commit into
mainfrom
docs/upate
Sep 6, 2025
Merged

docs(mkdocs): clean content and add short demo#45
benbenbang merged 1 commit into
mainfrom
docs/upate

Conversation

@benbenbang

Copy link
Copy Markdown
Owner

This pull request updates the documentation for Tombo to improve clarity and consistency in the feature descriptions. The main changes are the removal of emoji icons from feature headings and lists, and the addition of a more detailed demo section on the index page. These updates make the documentation more professional and easier to read.

Documentation consistency and clarity:

  • Removed emoji icons from feature section headings and bullet points in docs/docs/features/overview.md to standardize formatting and improve readability. [1] [2] [3] [4] [5] [6] [7] [8] [9]
  • Updated feature list formatting on the index page in docs/docs/index.md by removing emojis and simplifying headings for a more professional presentation.

Demo and onboarding improvements:

  • Replaced the step-by-step demo instructions with a video walkthrough and a clearer summary of the workflow in docs/docs/index.md, making it easier for users to understand Tombo’s capabilities.
  • Added a small formatting improvement for layout consistency in docs/docs/index.md.

@github-actions github-actions Bot added documentation Improvements or additions to documentation triage labels Sep 6, 2025
@benbenbang
benbenbang enabled auto-merge (squash) September 6, 2025 13:02
@benbenbang
benbenbang merged commit c7505dc into main Sep 6, 2025
2 checks passed
@benbenbang
benbenbang deleted the docs/upate branch September 6, 2025 13:02
@ptah-technical-app

Copy link
Copy Markdown

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation released triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant