หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

repository documentation starknet

เว็บไซต์ Starknet Docs, https://docs.starknet.io เขียนใน Asciidoc และสร้างขึ้นโดยใช้ Antora ซึ่งเป็นเครื่องกำเนิดเว็บไซต์แบบคงที่สำหรับ Asciidoc

มีส่วนร่วมในเอกสาร Starknet

หากคุณสนใจที่จะมีส่วนร่วมในเอกสารทางเทคนิคของ Starknet ตารางต่อไปนี้จะมีลิงค์ด่วนเพื่อช่วยคุณเริ่มต้น

คำถาม

ทรัพยากร

ฉันสนใจฉันจะมีส่วนร่วมได้อย่างไร?

สำหรับข้อมูลเกี่ยวกับวิธีที่คุณสามารถมีส่วนร่วมดูวิธีการต่าง ๆ ในการมีส่วนร่วม

มีแนวทางพื้นฐานที่จะช่วยฉันได้ไหม?

สำหรับแนวทางพื้นฐานที่จะช่วยให้เรารักษาเนื้อหาของเราให้สอดคล้องกันดูแนวทางเอกสาร

มีคู่มือสไตล์และคู่มือการเขียนที่ฉันควรใช้หรือไม่?

ดูคู่มือสไตล์เสริม Starknet เอกสารเสริม

ฉันจะตั้งค่าเวิร์กสเตชันได้อย่างไร?

ดูการตั้งค่าสภาพแวดล้อมของคุณ

วิธีที่แตกต่างกันในการมีส่วนร่วม

มีหลายวิธีที่แตกต่างกันที่คุณสามารถมีส่วนร่วมในเอกสาร Starknet:

  • สร้างปัญหา GitHub

  • ส่งคำขอดึง (PR) คุณสามารถสร้างโคลนในท้องถิ่นของส้อมของคุณเองของที่เก็บ Starknet-Docs ทำการเปลี่ยนแปลงและส่ง PR ตัวเลือกนี้ดีที่สุดหากคุณมีการเปลี่ยนแปลงที่สำคัญหรือเพื่อช่วยการเปลี่ยนแปลงที่คุณต้องการเพิ่มได้เร็วขึ้น

จะเกิดอะไรขึ้นเมื่อคุณส่ง PR?

เมื่อคุณส่ง PR ทีม Starknet Docs จะตรวจสอบ PR และจัดรีวิวทางเทคนิคเพิ่มเติมตามความจำเป็น หาก PR ต้องการการเปลี่ยนแปลงผู้ตรวจสอบจะเพิ่มความคิดเห็นใน PR เราอาจขอให้คุณทำการเปลี่ยนแปลงหรือแจ้งให้คุณทราบว่าเรารวมเนื้อหาของคุณไว้ใน PR อื่น ในบางครั้งเราอาจเพิ่มการดำเนินการกับ PR ดั้งเดิมโดยตรง เมื่อการตรวจสอบ PR ได้รับการตรวจสอบและการอัปเดตทั้งหมดเสร็จสมบูรณ์ทีมเอกสารจะรวม PR และนำไปใช้กับเวอร์ชันที่ถูกต้อง

เคล็ดลับในการเขียน

  • เอกสารประกอบเอกสารเสริม Starknet คู่มือสไตล์: คำแนะนำสไตล์ทั่วไปและคำแนะนำการเขียน

สำหรับข้อมูลเกี่ยวกับการเขียนใน asciidoc โปรดดู:

  • เอกสารภาษา ASCIIDOC

  • Asciidoc ไวยากรณ์การอ้างอิงด่วน

บันทึก

มีหลายวิธีในการเข้ารหัสรหัสบล็อกซอร์สโค้ดการอ้างอิงข้ามและลิงก์ โดยทั่วไปเราใช้อนุสัญญาการเข้ารหัสที่ชัดเจนที่สุดสำหรับการเข้ารหัสเพื่อจัดลำดับความสำคัญของการอ่านรหัส อนุสัญญาการเข้ารหัสเหล่านี้ส่วนใหญ่มีการระบุไว้ในการอ้างอิงอย่างรวดเร็วของ ASCIIDOC MARK-UP สำหรับเอกสารประกอบ Red Hat

ก่อนที่คุณจะเริ่ม

  1. ติดตั้ง yarn หากยังไม่ได้ติดตั้ง

  2. ติดตั้ง npx หากยังไม่ได้ติดตั้ง

  3. โคลน repo นี้ไม่ว่าจะมาจากส้อมหรือถ้าคุณเป็นผู้ทำงานร่วมกันอย่างเป็นทางการจากนั้นโดยตรงจาก starknet-io/starknet-docs

  4. เปลี่ยนเป็นไดเรกทอรี starknet-docs

  5. เรียกใช้คำสั่ง yarn เพื่อเตรียมสภาพแวดล้อม:

     เส้นด้าย

yarn ควรเตรียมสภาพแวดล้อมของคุณโดยการติดตั้งโมดูลที่ต้องการตาม package-lock.json และ package.json หากประสบความสำเร็จคุณควรจะสามารถสร้างและดูตัวอย่างเนื้อหาได้

การสร้างและดูตัวอย่างเนื้อหาในพื้นที่

หลังจากเขียนหรือแก้ไขเนื้อหาเพื่อดูตัวอย่างการเปลี่ยนแปลงของคุณ:

  1. สร้างเนื้อหาโดยเรียกใช้สคริปต์ build_local_site.sh : 

    ./build_local_site.sh

    คำสั่งนี้สร้างเว็บไซต์ในไดเรกทอรี public_html

  2. เปิดเว็บไซต์โดยทำอย่างใดอย่างหนึ่งต่อไปนี้:

    • เปิดหน้าเริ่มต้น: <repo_root>/public_html/index.html

    • เรียกใช้เซิร์ฟเวอร์ HTTP ที่บรรจุด้วย Antora: 

      npx http-server public_html -c-1

      เซิร์ฟเวอร์ทำงานและให้ URL ในเครื่องหนึ่งหรือมากกว่าหนึ่งรายการที่คุณสามารถใช้เพื่อดูเว็บไซต์ ตัวอย่างเช่น: 

      Starting up http-server, serving public_html

...

Available on:
  http://127.0.0.1:8080
  http://192.168.68.111:8080
  http://192.168.14.3:8080
  http://10.14.0.2:8080
Hit CTRL-C to stop the server

ปล่อยเอกสาร Starknet บน GitHub (สำหรับผู้ดูแลระบบเท่านั้น)

กระบวนการระดับสูงสำหรับการปล่อยเอกสารการเปลี่ยนแปลงในที่เก็บนี้

ในระหว่างการพัฒนาเนื้อหานักเขียนจะรวมสาขาที่มีการเปลี่ยนแปลงโดยตรงเป็น main เป็นสาขารองตามความจำเป็นซึ่งการเปลี่ยนแปลงเหล่านี้รอจนกว่าเราจะพร้อมที่จะปล่อยพวกเขา - นั่นคือโพสต์ไว้ใน docs.starknet.io

การกระทำของ GitHub สร้างแท็ก GIT และการเผยแพร่ที่ปรากฏในการเปิดตัวของ Repo และหน้าแท็ก

เมื่อสาขาฟีเจอร์ถูกรวมเข้ากับสาขา main กระทำของ GitHub จะสร้างแท็กรีลีสในรูปแบบ v<version>.<major_update>.<minor_update> และอัปเดต CHANGELOG.md จากนั้นจะเผยแพร่เนื้อหาใหม่ไปยัง docs.starknet.io

ขั้นตอน

การรวมสาขาฟีเจอร์เข้ากับ main เผยแพร่การเปลี่ยนแปลงโดยอัตโนมัติในสาขาฟีเจอร์ ไม่จำเป็นต้องมีขั้นตอนเพิ่มเติม

GitHub เพิ่มหมายเลขเวอร์ชันใน package.json และ package-lock.json และอัปเดต CHANGELOG.md พร้อมคำอธิบายของแต่ละ PR ที่เพิ่งรวมเข้ากับ main - อัปเดตสาขา main ในพื้นที่ของคุณจากสาขา main ระยะไกลโดยใช้หนึ่งในสิ่งต่อไปนี้:

  • ดึงการเปลี่ยนแปลง: 

    starknet-docs (main) git pull

  • ทำการรีไซเคิลจาก [email protected]:starknet-io/starknet-docs.git : 

    starknet-docs (main) git fetch origin
starknet-docs (main) git rebase origin/main
    บันทึก

    หากคุณกำลังใช้ส้อม repo ของคุณจะเป็น origin ตามค่าเริ่มต้นซึ่งในกรณีนี้คุณควรกำหนดชื่อ upstream ให้กับ [email protected]:starknet-io/starknet-docs.git ดังนั้นเมื่อ rebasing ให้ใช้ upstream แทนที่จะเป็น origin ในคำสั่งข้างต้น

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด