Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 12.8 KB

README.md

File metadata and controls

76 lines (58 loc) · 12.8 KB

เอกสาร DevStack · ยินดีต้อนรับ

สวัสดี และยินดีต้อนรับสู่เอกสารของ DevStack (devstack.bid) เราสร้าง NVX Stack Builder ขึ้นมาเพราะเบื่อการเริ่มโปรเจกต์ใหม่แล้วต้องไล่ค้นคำสั่งจากสิบแท็บ ว่าต้องติดตั้งอะไรก่อนหลัง บน Windows ต้องพิมพ์ต่างกันตรงไหน เอกสารชุดนี้คือที่ที่เราเล่าทุกอย่างให้ชุมชนฟังอย่างตรงไปตรงมา ตั้งแต่วิธีใช้งานไปจนถึงเบื้องหลังที่ทำให้มันทำงานได้

ภาษาหลักของเอกสารคือภาษาไทย และเราคงศัพท์เทคนิคเป็นภาษาอังกฤษ (เช่น template, composer, rate limit) เพื่อให้ค้นในโค้ดได้ตรงตัว หน้าที่มีฉบับภาษาอังกฤษจะบอกไว้ · Primary language: Thai with English technical terms. English sections are marked.

DevStack กับ NVX Stack Builder

DevStack คือชื่อโครงการและชุมชนของเรา ส่วน NVX Stack Builder คือผลิตภัณฑ์ตัวแรกที่เราเปิดให้ใช้ฟรีที่ devstack.bid มันเปลี่ยน "คำสั่งตั้งค่าโปรเจกต์" ให้เป็น Stack Template ที่เรียงลำดับแล้ว ตัดคำสั่งซ้ำแล้ว และมีคำอธิบายสองภาษา คุณเลือกเทมเพลตเอง หรือให้ AI agent ช่วยวางแผนก็ได้ จากนั้นปรับลำดับ ลบ เพิ่มขั้นตอน แล้วคัดลอก แชร์ หรือดาวน์โหลดเป็น setup.sh / setup.ps1 / .zip

สิ่งที่เรายึดไว้ตั้งแต่วันแรกคือ เซิร์ฟเวอร์ของเราไม่เคยรันคำสั่งใด ๆ แทนคุณ ทุกคำสั่งเป็นข้อความให้คุณอ่าน ตรวจ แล้วรันเองบนเครื่องของคุณ เหตุผลอยู่ใน Safety model

เอกสารชุดนี้ใช้งานได้จริง ไม่ใช่แค่ตัวอย่าง

ทุกหน้าที่คุณอ่านบน devstack.bid/docs สร้างจากไฟล์ Markdown จริงในโฟลเดอร์ docs/ ของ repo ตอน build ไม่มีการเขียนเนื้อหาซ้ำอีกชุด เราจึงทำให้หยิบไปใช้ต่อได้ทันที:

  • ปุ่ม คัดลอก Markdown ทุกหน้า ได้ไฟล์ต้นฉบับแบบไบต์ต่อไบต์ เอาไปวางใน wiki ของทีมหรือส่งให้ AI ได้เลย
  • ดูไฟล์ดิบ เติม .md ท้าย URL เช่น /docs/user-guide/getting-started.md จะได้ text/markdown ตรง ๆ
  • ทุกบล็อกโค้ดมีปุ่ม คัดลอก ของตัวเอง
  • สำหรับ AI agent เรามี /llms.txt เป็นสารบัญลิงก์ไฟล์ดิบทุกหน้า และ /llms-full.txt รวมทุกหน้าไว้ในไฟล์เดียว
  • ช่องค้นหาด้านซ้ายค้นได้ทั้งภาษาไทยและอังกฤษ และค้นจากในเบราว์เซอร์ทั้งหมด

ถ้าอยากรู้ว่าระบบเอกสารนี้ทำงานอย่างไร อ่านต่อที่ Docs site

เริ่มอ่านตรงไหนดี · Who should read what

คุณคือ เริ่มที่ จากนั้น
นักพัฒนาที่อยากได้คำสั่งตั้งค่าโปรเจกต์ Getting started Builder, AI agent, Downloads, FAQ
ผู้ร่วมพัฒนา (contributor) Concepts: Stack Template Add a template, Testing, File map
ผู้ดูแลระบบ / DevOps Local dev Env & secrets, Deploy, Rollback, Monitoring
สถาปนิก / reviewer Architecture overview Data flow, Subsystem history
AI agent ที่ต้องดูแลแพลตฟอร์ม เมนูฟังก์ชัน NVX DEVELOPER BOTH, cursor-agents.json, Agent playbook
ผู้ใช้ MCP จาก Cursor หรือ AI platform อื่น MCP integration เมนูฟังก์ชัน, API key settings

แผนผังเอกสาร · Site map

แหล่งความจริง · Where truth lives

เมื่อเอกสารกับโค้ดขัดกัน เราถือว่า โค้ดคือความจริง แล้วรีบแก้เอกสารให้ตรง แหล่งความจริงหลักคือ รายการเทมเพลต src/data/templates/index.ts, ชนิดข้อมูล src/lib/types.ts, ตรรกะการประกอบคำสั่ง src/lib/composer.ts, ตัวแปรสภาพแวดล้อม src/lib/server/env.ts, การตั้งค่า Worker wrangler.jsonc, ค่าดีไซน์ src/app/tokens.css และประวัติการเปลี่ยนแปลง CHANGELOG.md + git log

เอกสารสร้างจากโค้ดและ git history จริง (v0.1.0 → v0.5.1) ทุกข้อเท็จจริงด้านประวัติอ้างอิง commit hash และ tag ตรวจย้อนได้ และมี npm run docs:check คอยตรวจว่าเอกสารยังตรงกับโค้ด (ดู docs-maintenance)

ช่วยเราทำให้เอกสารดีขึ้น

เราเพิ่งเริ่มต้น และเอกสารที่ดีเกิดจากคำถามของคนที่ลองใช้จริง ถ้าเจอจุดที่อ่านแล้วงง ขั้นตอนที่ไม่ตรงกับหน้าจอ หรืออยากให้มีเทมเพลตใหม่ บอกเราได้เสมอ ผู้ร่วมพัฒนาเริ่มได้จาก add-template.md และ docs-maintenance.md ขอบคุณที่มาเป็นส่วนหนึ่งของ DevStack