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

docs: added a toc for the readme #794

Merged

Conversation

dustinwloring1988
Copy link
Collaborator

@dustinwloring1988 dustinwloring1988 commented Dec 17, 2024

Added a TOC for the README file, renamed some headings to better suite the TOC:

image

added a TOC for the README file, renamed some headings to better suite the TOC
@dustinwloring1988 dustinwloring1988 changed the title add: toc for the readme docs: added a toc for the readme Dec 17, 2024
@dustinwloring1988 dustinwloring1988 added the documentation Improvements or additions to documentation label Dec 17, 2024
@dustinwloring1988 dustinwloring1988 merged commit de64007 into stackblitz-labs:main Dec 19, 2024
4 checks passed
@dustinwloring1988 dustinwloring1988 deleted the add/toc-for-readme branch December 19, 2024 20:07
@aliasfoxkde
Copy link
Collaborator

I always do this in my own projects. Usually split up docs into parts and create navigation. So, I agree.

Only concern would be the README.md is getting pretty long.

Copy link
Collaborator

@aliasfoxkde aliasfoxkde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with all the changes and cleanup.

@dustinwloring1988
Copy link
Collaborator Author

@aliasfoxkde for sure I hoping to make the README shorter but figured at least a TOC for now would be helpful. This weekend I was going to devote some time to the docs, Once the chat history tab is changed I was going to make a quick little user guide with some images that we could expand on as I think we need a away to show off some of bolt.diy features.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants