Skip to content
This repository has been archived by the owner on Jan 3, 2023. It is now read-only.

Latest commit

 

History

History
128 lines (89 loc) · 3.03 KB

README.md

File metadata and controls

128 lines (89 loc) · 3.03 KB
Raw

dfuse Documentation

We welcome contributions to improve the documentation. Simply open a pull request to start collaborating!

Requirements

  • Hugo Extended (with SCSS support), version 0.58.3 or higher
  • Install from source (with SCSS support) with:
git checkout github.com/gohugoio/hugo
cd hugo
go install -v --tags extended

Development

To start the hugo server, run this command:

hugo server

GraphQL API Reference

The GraphQL API Reference content is generated straight from the GraphQL schema of the different products we support.

To update them, a pre-defined project layout on disk is expected by the script. You must have the three following project colocated as siblings alongside the docs project:

  • docs
  • dfuse-eosio
  • dfuse-ethereum

The later two must be named verbatim, the first one docs could be named whatever you like. Once the following layout exist on your local workstation, to update the GraphQL generate API reference data, first install the script dependencies:

npm install

Then run the following command:

node graphql.js

This should update the file data/eos/graphql.json and data/eth/graphql.json (and any other chains we now support) if the GraphQL schema has been updated.

Content Structure

All content can be found in the /content directory. The structure of the website is generated automatically based on the structure of that directory.

Style guide

Links

  • 1.1 external: When you insert an external link use the external-link shortcode

    {{< external-link href="https://app.dfuse.io" title="dfuseio" >}}
{{< external-link href="https://app.dfuse.io">}}

  • 1.2 internal references: Please put all internal references as full paths, for greppability and refactoring.

Example code

Use the following begin and end tags to indicate code sections that need to be referenced:

// CODE:BEGIN:quickstarts_javascript_node_eos_section1
function() {
  var some = "code"
}
// CODE:END:quickstarts_javascript_node_eos_section1

Section names need to follow the path of the file from project root. For example the example snippet is from the file:

├── quickstarts
│   └── javascript
│       └── node
│           └── index.eos.js
├── guides
└── ...

When hugo builds the site, the code sections are extracted and stored in the data folder in project root. Example code can then be referenced with the following shortcode:

{{< code-section "quickstarts_javascript_node_eos_section1" >}}

Lexicon guide

  • web application
  • website
  • dfuse
  • real-time
  • GraphQL
  • API

Deployment

Any commit to master automatically triggers a deployment. For this reason, the master branch is locked, requiring all changes to go through an approved pull request.

Reference ETH -=> Endpoint ALPHA

side menu

alpha (red) beta (yeallo-orangy) stage (light gray) add sub-title to graphql shortcode fix

refactor pages