ZachGoldberg / Startup-CTO-Handbook

The Startup CTO's Handbook, a book covering leadership, management and technical topics for leaders of software engineering teams
https://ctohb.com
Other
10.18k stars 488 forks source link

Refactor File Structure and Naming in startup_cto_handbook #15

Closed tavallaie closed 1 year ago

tavallaie commented 1 year ago

This pull request includes two main commits that focus on improving the structure, naming conventions, and overall organization of the startup_cto_handbook.

Commit 1: Renamed and restructured files in StartupCTOHandbook for clarity and consistency. Updated file names to follow a more consistent pattern, enhancing clarity and navigability. Modified certain sections and files for improved organization. Commit 2: Refactor File Structure and Naming in startup_cto_handbook. File Deletions:

Removed the unused cover from the published_files directory. Deleted outdated files in the 02_people_and_culture directory. File Modifications:

Updated the table of contents (01_toc.md) in the 01_pretext_and_introduction directory. File Renaming & Restructuring:

Renamed and restructured several files in the startup_cto_handbook. Untracked Files Added:

Added markdown versions for previously deleted files in startup_cto_handbook. Rationale: The main objective of these changes is to enhance the clarity, consistency, and navigability of the startup_cto_handbook. By refining the file structure, adopting consistent naming conventions, and making necessary deletions and additions, we aim to improve the user experience for contributors and readers.

I kindly request a review of these changes and welcome any feedback or suggestions.

ZachGoldberg commented 1 year ago

Hi @tavallaie!

Thanks a ton for your pull request and efforts into refactoring the repo. Can you elaborate a bit more on the motivation for the changes? It's not obvious to me that breaking out the single .md file into many is an improvement to the user-experience for the casual passer-by that finds this repository and wants to preview the latest version of the book.

As it stands now, if you're new here and haven't bought the book/e-book on Amazon and want to read it on GitHub, you can click into the published files and immediately download the whole thing as a PDF, or view the whole thing in-browser as GitHub rendered markdown. The "traffic insights" on this repository actually show that the vast majority of users who land on the README click into the .md file, which gives them all the content at once, no need to explore or jump around.

Looking forward to your thoughts, Zach

tavallaie commented 1 year ago

Hi Zach,

Thanks for your insights. The restructuring aimed to streamline contributions, making it easier to edit specific sections without navigating a lengthy file. However, I recognize the need for a smooth reading experience.

To address this, we could use GitHub Pages or GitBook. These platforms can consolidate the markdown files into a cohesive view, complete with a navigation sidebar, enhancing the in-browser reading. Plus, with GitHub Actions, we can automate the creation of up-to-date PDFs and Epubs, ensuring readers always have access to the latest version in their preferred format.

I believe this approach strikes a balance for both contributors and readers. Keen to hear your thoughts.

Best regards, Ali

tavallaie commented 1 year ago

For example of an updating book with that structure I publish my book here on github and Host it on gitbook.com with personal domain for free.

tavallaie commented 1 year ago

because there is no further response for this PR from the maintainers I close it.