Sequence® Clone Documentation

Built using Docusaurus.

Running Docusaurus locally

npm run start

Building Steps Documentation

Update the Sequence submodule to the latest version.

git -C ./steps-gen/sequence fetch
git -C ./steps-gen/sequence checkout <VERSION>

Build sequence console:

dotnet publish -c Release -o ./.sequence steps-gen/sequence/Sequence/Sequence.csproj
cp ./steps-gen/sequence-appsettings.json ./.sequence/appsettings.json
cp ./steps-gen/connectors.json ./.sequence/connectors.json

Run the doc generation SCL:

./.sequence/sequence run ./steps-gen/build-docs.scl

Validating Documentation SCL

Build sequence console first. Then run the Validate-SCL script which will validate all scl code blocks in .md files in the ./docs directory.

./Validate-SCL.ps1

It's also possible to specify a file or directory to validate:

./Validate-SCL.ps1 -Path ./docs/entities.md

To ignore a code block, add a #ignore right after scl:

```scl #ignore
(prop: 1)
```

Adding New Connectors to the Documentation

1. Add the connector to the configuration in steps-gen/connectors.json. This will enable step documentation to be generated for this connector.
2. Add connector description and settings to docs/connectors/
3. Add any connector examples to docs/examples
4. Add connector description and name to steps-gen/build-docs.scl.

Updating Documentation for New Releases

All the documentation that is in the docs and steps folders is published as the -alpha version. For release version, a snapshot needs to be created:

1. Remove previous version of sequence console (if exists) and steps

   rm -rec -for ./.sequence
   rm -rec -for ./steps/*

2. Update the scl-editor ref for the build:docusaurus job in .gitlab-ci.yml

3. Update the connector versions in ./steps-gen/connectors.json

4. Delete any versions older than six months.

5. Build the steps documentation

6. Create a new version snapshot for docs and steps (same version for both):

   npm run docusaurus docs:version v0.18.0
   npm run docusaurus docs:version:steps v0.18.0

7. Verify that the new versions work

   npm run start

8. After pushing to GitLab, verify that the playground works.

Building SCL Playground for Local Development

This is done automatically in the CI, but if developing locally:

Clone the scl-editor project into the same directory as sequence-docs.

Remove-Item -rec -for ./playground -ErrorAction SilentlyContinue
New-Item -ItemType Directory -Path ./playground | Out-Null
dotnet publish --configuration Release --output ./scl-playground ../scl-editor/SCLEditor.React/SCLEditor.React.csproj
Move-Item ./scl-playground/wwwroot/* ./playground
Move-Item ./playground/index.html ./playground/playground-react.html
Remove-Item -rec -for ./scl-playground