ContextQMD
Back to Consul

Introduction

ui/packages/consul-ui/docs/index.mdx

1.22.71.4 KB
Original Source

Consul UI Engineering Docs

Welcome to Consul UIs engineering documentation.

Environment Variables

There are various environment variable you can use whilst running make start or make test to configure various features:

VariableDefault ValueDescription
TESTEM_AUTOLAUNCHChromeControls which browser to open tests in. A setting of "" means 'let me manually open the browser'
EMBER_TEST_REPORTOutput a test report
CONSUL_DOCFY_CONFIGDefine an additional docfy-config.json file to use

Adding documentation

Our documentation use docfy for rendering our markdown+glimmer-component documentation. In order to live render any code examples use the preview-template meta, for example:

md
```hbs
<YourComponent
  @thing={{var}}
/>
```

The above will render the same code snippet in a box above the snippet.

The location and name of markdown files within the project differs slightly depending on what you need to add documentation for:

  • docs: docs/filename.mdx
  • styles: app/styles/*/*/README.mdx (currently mostly in app/styles/base)
  • components: app/components/your-component-name/README.mdx
  • helpers: app/helpers/your-helper-name.mdx
  • modifiers: app/modifiers/your-modifier-name.mdx
  • services: app/services/your-service-name.mdx (eventually these will partly use jsdoc code style generation)