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

Added table of contents to README.md #66

Merged
merged 2 commits into from
Jan 8, 2025
Merged

Conversation

jackspiering
Copy link
Member

Pull Request Title: Added table of contents to README.md

Description

Added table of contents to README.md

Related Issues

  • N/A

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactoring

How Has This Been Tested?

  • N/A

Checklist

  • I have performed a self-review of my code
  • I have added tests that prove my fix or feature works
  • I have updated necessary documentation (e.g. frontpage README.md)
  • Any dependent changes have been merged and published in downstream modules

Screenshots (if applicable)

  • N/A

Additional Notes

  • N/A

@jackspiering jackspiering requested a review from crypt0rr January 6, 2025 20:47
Copy link
Member

@crypt0rr crypt0rr left a comment

Choose a reason for hiding this comment

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

Please fix comment.

README.md Outdated
@@ -6,6 +6,20 @@ The provided configurations showcase how to set up Tailscale alongside Docker se

If you would like to add your own config, you can use the [service-template](templates/service-template/) or simply open an [issue](https://github.com/2Tiny2Scale/tailscale-docker-sidecar-configs/issues).

## Table of Contents
- [Compose Configurations](#available-configurations)
Copy link
Member

Choose a reason for hiding this comment

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

Please change Compose Configurations to Available Configurations to reflect the actual title used.

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed

@jackspiering jackspiering requested a review from crypt0rr January 8, 2025 13:55
Copy link
Member

@crypt0rr crypt0rr left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@crypt0rr crypt0rr merged commit d809b42 into main Jan 8, 2025
1 check passed
@crypt0rr crypt0rr deleted the 20250601-tableofcontents branch January 8, 2025 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants