貢獻我們的文件
此文件網站託管在公開的 GitHub 儲存庫中。它使用 Next.js 構建，以 MDX 編寫，並部署在 Vercel 上。
我們的文件哲學
我們的文件旨在
- 高效：我們不想浪費任何人的時間
- 易於存取：閱讀此處的文字不應要求母語為英語或擁有電腦科學學位
- 詳盡：文件網站應包含任何人使用 Meilisearch 所需的所有資訊
- 開源：這是 Meilisearch 用戶為 Meilisearch 用戶提供的資源
文件儲存庫和本機開發
Meilisearch 文件儲存庫僅儲存文件網站的內容。由於構成該網站的程式碼位於另一個儲存庫中，因此無法執行文件的本機副本。
處理圖像和其他靜態資源
當向 Meilisearch 文件貢獻內容時，請將螢幕截圖、圖像、GIF 和影片儲存在 /assets 下的相關目錄中。
建置過程目前不支援具有相對路徑的靜態資源。將它們新增至文件時，請確保資產 URL 指向原始 GitHub 檔案位址
\!\[Image description\]\(https://raw.githubusercontent.com/meilisearch/documentation/[branch_name]/assets/images/[guide_name]/diagram.png\)
如何貢獻？
問題
Meilisearch 文件的維護者使用 GitHub Issues 來追蹤任務。有用的問題包括
- 通知文件團隊內容不正確、過時或令人困惑
- 要求新功能，例如版本控制或嵌入式主控台
- 要求新內容，例如新指南和教學課程
在開啟問題或 PR 之前，請瀏覽我們的開放問題，查看是否有您問題的現有問題。如果有，請留言告訴我們您正在等待修復或願意自己處理。如果沒有，請開啟一個新問題，描述問題並告知我們您是否要處理它。
我們喜歡 Meilisearch 的問題，因為它們幫助我們更好地完成工作。十分之九，最有用的貢獻是簡單的 GitHub 問題，指出問題並提出解決方案。
建立您的第一個問題
若要開啟問題，您需要一個 GitHub 帳戶。如有必要，請建立一個，然後按照這些步驟操作
- 登入您的帳戶
- 前往 Meilisearch 文件儲存庫
- 點擊「Issues」（議題）
- 使用搜尋列檢查是否有人回報了相同的問題。如果有的話，請按 👍 投票，不要建立新的議題！
- 如果沒有人回報您遇到的問題，請點擊「New issue」（新議題）
- 寫一個簡短且具描述性的標題，然後加入較長的摘要來說明問題。如果您回報的是錯誤，請務必包含重現錯誤的步驟，以及您的作業系統和瀏覽器版本
- 點擊「Submit new issue」（提交新議題）
- 我們團隊的成員應該會很快地 回覆您
- 享受完成工作的感覺！🎉
Pull requests (拉取請求)
您也可以透過發送 拉取請求 來改善文件。
拉取請求（簡稱「PR」）是將變更整合到 GitHub 儲存庫的請求。在我們的文件中建立 PR 最簡單的方法是使用每頁左下角的「Edit this page」（編輯此頁面）連結。
當您想要以下情況時，拉取請求特別好用：
- 解決一個 現有的議題
- 修正小錯誤，例如錯字或損壞的連結
- 建立或改進您非常了解的內容—例如，關於如何將 Meilisearch 與您已掌握的工具整合的指南
在大多數情況下，最好在發送 PR 之前建立一個議題。這可讓您與文件維護者協調，並找到解決您想解決的問題的最佳方法。
建立您的第一個 PR
要建立 PR，您需要一個 GitHub 帳戶。如有必要，請建立一個帳戶，然後按照以下步驟操作
- 前往您要編輯的文件頁面，向下捲動，然後點擊螢幕左下角的「Edit this page」（編輯此頁面）。這會將您帶到 GitHub
- 如果您尚未登入，請立即登入。系統可能會提示您建立一個 fork
- 使用 GitHub 的文字編輯器更新頁面
- 向下捲動直到您看到一個名為「Propose changes」（提出變更）的方塊
- 填寫第一個欄位，為您的 PR 提供一個簡短且具描述性的標題—例如，「修正搜尋 API 參考中的錯字」
- 使用第二個欄位新增您提議變更的更詳細說明
- 點擊「Propose changes」（提出變更）按鈕以繼續。您應該會看到一個寫著「Comparing changes」（比較變更）的頁面
- 請確保基礎儲存庫設定為
meilisearch/documentation，基礎分支設定為main。您可以忽略其餘欄位 - 此畫面還會顯示一個「差異」，可讓您看到您所做的變更與目前發佈在文件網站上的內容之間的差異
- 點擊「Create pull request」（建立拉取請求）
- 恭喜，您發送了您的第一個 PR！ 文件維護者將很快審閱您的拉取請求。他們可能會要求變更，請密切注意您的 GitHub 通知
- 如果一切順利，您的工作將會合併到
main分支中，並成為官方文件網站的一部分。您現在是 Meilisearch 的貢獻者！🚀
我們如何審閱貢獻
我們如何審閱議題
在審閱議題時，我們會考慮一些標準
- 這項任務對文件維護者來說是否為優先事項？
- 文件網站是否為此資訊的最佳位置？有時候，一個想法在我們的部落格上可能比在文件中效果更好，或者連結到外部資源可能比我們自己撰寫和維護更有效
- 如果是錯誤回報，我們可以重現錯誤嗎？
如果使用者透過投票或回報類似問題來表達對某個議題的興趣，那麼文件就更可能將資源投入到該任務中。
我們如何審閱 PR
對於審閱貢獻者的 PR，我們會先確保 PR 符合我們的品質標準。
我們會問以下問題：
- 資訊是否準確？
- 是否容易理解？
- 程式碼範例是否能無錯誤執行？它們是否能幫助使用者理解我們正在解釋的內容？
- 英文是否清晰簡潔？非母語人士是否能理解？
- 文法是否完美？是否有任何錯字？
- 我們是否可以在不遺失任何重要資訊的情況下縮短文字？
- 建議的變更是否需要更新文件網站中的其他頁面？
- 如果是新內容，文章是否放在正確的位置？文件中的其他文章是否應連結到它？
沒有什麼比周到且有幫助的 PR 更讓我們開心的了。您的 PR 通常可以節省我們的時間和精力，並使文件更加強大。
我們對 PR 貢獻的唯一主要要求是，作者在合理的時間範圍內回覆通訊請求。
一旦您在此儲存庫中開啟 PR，我們團隊的成員將很快停止審閱它。如果您的 PR 獲得核准，則無需您進一步處理。然而，如果您在七天內沒有回覆進一步變更或更多資訊的要求，我們將視為 PR 已放棄並關閉它。
如果您發生這種情況，並且您認為有誤，請告訴我們，我們會盡力糾正這種情況。
貢獻給 Meilisearch
還有許多方法可以直接貢獻給 Meilisearch，例如：
也有許多有價值的方法可以支援上述儲存庫：
- 提供意見反應
- 建議功能
- 建立測試
- 修正錯誤
- 新增內容
- 開發功能