Enhance README with repository structure overview

Added an overview of the repository structure and updated the last updated date.
This commit is contained in:
Jacob Kraniak 2026-03-07 20:47:28 -05:00 committed by GitHub
parent 85c70a043b
commit f9e7451bd3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 38 additions and 4 deletions

View File

@ -15,11 +15,45 @@ When ready: Plan to squash-merge or rebase + clean history into main.
**Forked on 2026-03-03** from [trimstray/the-book-of-secret-knowledge](https://github.com/trimstray/the-book-of-secret-knowledge) (MIT licensed, last major upstream activity ~2024).
## Repository Structure Overview
This is a living knowledge base of tools, techniques, one-liners, cheatsheets, and references — focused on security, networking, sysadmin, and devops. (LAST UPDATED 2026-03-07)
##### :black_small_square: Network (HTTP)
```text
the-book-of-secret-knowledge/
├── .github/ # Workflows, issue templates, etc.
├── .obsidian/ # Optional Obsidian vault config (personal notes)
├── documentation/ # Guides, how-tos, one-liners, cheat sheets
│ ├── learning-resources/ # Daily knowledge, news, articles
│ │ └── daily-knowledge-news.md
│ ├── manuals-howtos-guides/ # Shell tricks, functions, practical guides
│ │ ├── shell-one-liners.md
│ │ └── shell-tricks-functions.md
│ ├── other-cheat-sheets.md
│ └── readme - to refactor.md # (legacy — planned migration)
├── tools/ # Curated tool lists (following TOOL-TABLE-SCHEMA.md)
│ ├── 00_index.md # → planned rename to INDEX.md
│ ├── my-contributions.md # Personally added / heavily used tools
│ ├── system-services.md
│ ├── network-engineering/ # Diagnostics, DNS/IPAM, routing/BGP/OSPF
│ │ ├── diagnostics-troubleshooting/ # Bandwidth tests, tracing, protocols
│ │ ├── dns-dhc-ipam/
│ │ └── routing-bgp-ospf/
│ ├── security/ # Pentest, recon/enum, SSL/TLS, vuln/exploit
│ │ ├── pentest-recon-enum/ # Packet capture, scanners, OSINT
│ │ ├── ssl-tls-web-security.md
│ │ └── vuln-analysis-exploitation/ # Packet crafting, exploit DBs
│ └── sysadmin-devops/ # Remote access, monitoring, shell/terminal tools
│ ├── https-web-services/ # Benchmark, browsers, inspectors
│ ├── system-monitoring-tracing/
│ └── terminal-shell-productivity/ # Shells, editors, file utils
├── .gitignore
├── .markdownlint.json
├── .markdownlintignore
├── Contributing.md
├── LICENSE.md
├── README.md # ← You are here
└── TOOL-TABLE-SCHEMA.md # Standard format for all tool-list .md files
##### :black_small_square: SSL
@ -1242,4 +1276,4 @@ AWS deployment tool.<br>
&nbsp;&nbsp; <a href="https://github.com/cirosantilli/x86-bare-metal-examples"><b>x86 Bare Metal Examples</b></a> - dozens of minimal operating systems to learn x86 system programming.<br>
&nbsp;&nbsp; <a href="https://github.com/djhworld/simple-computer"><b>simple-computer</b></a> - the scott CPU from "But How Do It Know?" by J. Clark Scott.<br>
&nbsp;&nbsp; <a href="https://littleosbook.github.io/"><b>littleosbook</b></a> - the little book about OS development.<br>
</p>
</p>