Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

CovenantSQL Docs

Documentation of CovenantSQL and related tools, build with Docusaurus.

Docs update

docs

Update markdown docs in /docs folder, and make sure every doc file has the header structure as following:

---
id: $doc_id
title: $doc_title
---

sidebar

Update sidebar from website/sidebars.json:

{
  "docs": {
    "Intro": [ // category name
      "intro" // doc_id
    ],
    ...
    "About": [
      "usecase",
      "qna"
    ]
  }
}

Publish

before publish

  • install yarn
  • install node module dependencies cd website && yarn install

ship

  • chmod +x ./ship.sh
  • ./ship.sh -v $version -u $github_username