Giter Club home page Giter Club logo

galxe-docs's Introduction

โš ๏ธ Galxe docs have been moved to https://github.com/Galxe/docs. This repo is now deprecated and no longer maintained.

galxe-docs

CMS

This is yet to be optimized but here is a simple workflow for creating a new entry:

  1. Go to https://docs.galxe.com/admin, then login with your github
  2. Go to appropriate collection and page
  3. Fill in required fields:
    1. Sidebar Label: Label to show in the sidebar.
    2. Sidebar Potision: Order of the current entry in the sidebar collection. Start from 1.
    3. Slug: Url of the current entry in the sidebar collection.
    4. Body: Must start with a title using "Heading 1"
  4. Save
  5. Go to workflow page https://docs.galxe.com/admin/#/workflow
  6. (TODO) If you drag your document to "in review", or "ready", it should create a pull request to the repo
  7. If you have write permission to this repo, you can click "publish now" to publish the entry
  8. Our doc is hosted on netlify, so it will take about 2 minutes to take effect

GraphQL documentation

Generate GraphQL documentation using our production endpoint with the following command:

yarn run doc:gen-graphql

galxe-docs's People

Contributors

oyyblin avatar keenagejj avatar moriahcausly avatar imllteth avatar stumble avatar meigalxe avatar alberthaotan avatar charleswayn avatar fico308 avatar archerlzj avatar chlzhu avatar weatherboyy avatar kimeleyk avatar mathxlee avatar gezr1997 avatar squintgit avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.