Contributing to Ceycode Dev Hub

This knowledge base is built by the team, for the team. Everyone is welcome to add, improve, or fix content — no contribution is too small.

What you can contribute

Content type	What it's for	Where it lives
Knowledge Base article	Concepts, guides, deep dives, comparisons, best practices	`docs/`
Blog post / TIL	Short discoveries, tips, personal experience write-ups	`blog/`

Knowledge Base (docs/) — reference material the team will revisit repeatedly. It belongs to a category (Languages, Frameworks, Concepts, etc.) and has a permanent place in the sidebar.
Blog (blog/) — things you learned recently, quick tips, tutorials written in first-person, or anything time-stamped by nature (a TIL, a post-mortem, a "we tried X" writeup).

If you're unsure, start with a blog post. Good ones often get promoted into the knowledge base later.

Add the following frontmatter at the top:

---
title: Your Post Title
authors: your_handle
tags: [relevant, tags]
description: One-line summary shown in previews.
---

Add yourself to blog/authors.yml if you're not already there:

your_handle:
  name: Your Name
  title: Your Role
  url: https://github.com/your-github
  image_url: https://github.com/your-github.png

Find the right category in docs/ — languages/, frameworks/, tools/, concepts/, or best-practices/.

If a new category is needed, create a folder and add a _category_.json file inside it:

{
  "label": "Your Category",
  "position": 10,
  "link": { "type": "generated-index" }
}

Create your .md file with frontmatter:

---
title: Article Title
sidebar_label: Short Label
description: One-line summary.
tags: [relevant, tags]
---

Write the article. Use headings, code blocks, and Mermaid diagrams where they help.
Open a pull request with a short description of what you added.

Tags power the Tags page and make content discoverable. Use them consistently:

Technology: java, typescript, react, docker, kubernetes, git, spring-boot, python, go
Content type: tutorial, til, best-practices, deep-dive, comparison
Topic: performance, security, databases, system-design, ci-cd, testing, networking, server-architecture

Share early — a rough draft beats a perfect article that never gets written.
Be specific — concrete examples and real code are more useful than abstract explanations.
Link, don't repeat — if something is covered elsewhere in the hub, link to it.
Keep it current — if you spot outdated content, update it in the same PR or open an issue.