Skip to content

docs: rewrite README with accurate project structure, navi… #5

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.

Sign up for GitHub

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

Merged
rayanahmax merged 2 commits into from
Jul 27, 2026
Merged

docs: rewrite README with accurate project structure, navi… #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b9f3e5c
docs: rewrite README with accurate project structure, no emojis, navi…
rayanahmax Jul 27, 2026
8bd1c1f
merge: resolve merge conflicts with main
rayanahmax Jul 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,23 @@ The `CIDRCalculator` component accepts optional `defaultIp` and `defaultCidr` pr

---

## Navigation Categories

The site organises tools into three categories used consistently across the navbar dropdown, homepage filter tabs, and homepage section headings:

| Category | Tools |
|---|---|
| Infrastructure & Config | Crontab to Systemd, Env to JSON, JSON to Env |
| Security & DevSecOps | PII Masker & Log Scrubber, K8s Manifest Sanitizer |
| Networking & Data | CIDR Subnet Calculator, CSV to JSON Schema Builder |

These category labels are defined in two places:

- `src/components/shared/Navbar.astro` — `toolCategories` array drives the desktop dropdown and mobile menu
- `src/pages/index.astro` — filter tab labels and section `<h2>` headings

---

## Project Structure

```
Expand Down
Loading