mirror of
https://github.com/ByteByteGoHq/system-design-101.git
synced 2026-04-01 16:57:23 -04:00
ee4b7305a2
This PR adds all the guides from [Visual Guides](https://bytebytego.com/guides/) section on bytebytego to the repository with proper links. - [x] Markdown files for guides and categories are placed inside `data/guides` and `data/categories` - [x] Guide links in readme are auto-generated using `scripts/readme.ts`. Everytime you run the script `npm run update-readme`, it reads the categories and guides from the above mentioned folders, generate production links for guides and categories and populate the table of content in the readme. This ensures that any future guides and categories will automatically get added to the readme. - [x] Sorting inside the readme matches the actual category and guides sorting on production
683 B
683 B
Contributing
Thank you for your interest in contributing! Here are some guidelines to follow when submitting pull requests:
Pull Requests
- Each pull request should focus on a single topic or concept.
- Avoid making changes across multiple topics in the same PR.
- Give your PR a clear title summarizing the topic you are addressing.
- If you notice typos or issues in diagrams, please open a separate issue instead of fixing the images directly. We will update the source images and republish fixes.
GitHub Pull Requests Docs
If you are not familiar with pull requests, review the pull request docs.