<commit_before># Digital Guides
> https://guides.service.gov.au/

> We aim to provide clear, consistent and compelling guidance which will inspire teams and help support them with how to design and deliver great digital services.

### Layout documentation

https://govau.github.io/service-manual/docs/

### Visual regression tests

https://github.com/govau/backstop-guides-tests

## Staging environment

- **url**: [https://service-manual.apps.y.cld.gov.au/](https://service-manual.apps.y.cld.gov.au/)
- **branch**: `develop`
- **status**:  [![CircleCI](https://circleci.com/gh/govau/service-manual/tree/develop.svg?style=svg)](https://circleci.com/gh/govau/service-manual/tree/develop)


## Development

All pull requests should be compared against `develop`

**It's good to use NVM**

```shell
nvm use
```

**Install dependencies**

```shell<commit_msg>Add some detail about generating the auto-docs.<commit_after># Digital Guides
> https://guides.service.gov.au/

> We aim to provide clear, consistent and compelling guidance which will inspire teams and help support them with how to design and deliver great digital services.

### Partial (layout) documentation

https://govau.github.io/service-manual/docs/

The Cuttlebelle auto-docs are deployed to the `gh-pages` branch.

To update the documentation after changing or adding a partial, change to the `gh-pages` branch and run `npm run docs`. Push it to deploy.

### Visual regression tests

https://github.com/govau/backstop-guides-tests

These can be optionally run before a production deployment to visually see the difference.

It's good for non-functional changes to ensure there is no visual regression.

## Staging environment

- **url**: [https://service-manual.apps.y.cld.gov.au/](https://service-manual.apps.y.cld.gov.au/)
- **branch**: `develop`
- **status**:  [![CircleCI](https://circleci.com/gh/govau/service-manual/tree/develop.svg?style=svg)](https://circleci.com/gh/govau/service-manual/tree/develop)


## Development

All pull requests should be compared against `develop`.

It's recommended you install `nvm` to manage your local node version.

**Change node version**

```shell
nvm use
```

**Install dependencies**

```shell
{'fraction_non_alphanumeric': 0.13669391462306993, 'fraction_numerical': 0.0, 'mean_word_length': 4.563131313131313, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '271084', 'n_tokens_mistral': 675, 'n_tokens_neox': 639, 'n_words': 204}