This website is built using Docusaurus 2, a modern static website generator.

cd docs
npm install

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

For your search bar to work locally the above command is not sufficient. You have to generate the static content and then serve it locally.

npm run build
npm run serve

npm run build

This command generates static content into the dist directory and can be served using any static contents hosting service.

Before every commit, vale will run against every Markdown file under docs/.

Do the following to install Vale and the AskUI style guide.

• Install Vale instructions.
• Clone the askui-vale repository
• Symlink the styles to your .github folder

ln -s <Path to cloned askui-vale-repository from .github folder>/styles .github/styles

To run Vale manually before committing:

cd docs
vale docs

The blog is stored under docs/blog. Every entry gets its own folder and we use the following format as a naming convention YYYY-MM-DD. This makes sorting easier. Inside the folder you can store images and maximum one Markdown file (.md file extension). The Markdown file contains your Release Note entry.

Every Release Note has a metadata header that looks like this. Choose a unique title and slug.

---
title: 2023.12.13 Annotate DetectedElements from get()
slug: release-notes-annotate-detected-elements
authors: [leonmeier, johannesdienst]
tags: [ReleaseNotes]
hide_table_of_contents: false
---

If you want to add a new author follow the convention in authors.yml. The author-image has to be added to docs/static/img.

1. Head over to askui-inference
2. Copy over the generated documentation
3. Adjust API documentation wherever we override it in UiControlClient

Your branch name should conform to the format <issue id>-<issue title lower-cased and kebab-cased>, e.g., let's say you have an issue named Hello World with id AS-101, the branch name would be AS-101-hello-world. We use the issue id prefix to prepend a link to the issue to the commit message header. In some cases, when doing a quick fix of a typo etc. when there is no issue, feel free to just use a descriptive name of what you are doing, for example, fix-typo-in-example-readme.

Commit messages should conform to Conventional Commits Message Standard. Exceptions to this rule may be merge commits.

The one version rule should be followed as much as possible. In practice, this mean checking if a dependency to be added is already used by another package or meant to be used by multiple packages. If not, install it inside the corresponding package's root directory. If it is shared, install it in the project's root directory and make sure that you only need to depend on this single version in all packages.

This repository uses githooks with husky to lint and test the code, to help you stick to the commit message standard by opening up a CLI for constructing the commit message on each commit, prepending the commit message with the issue number or linting the commit message etc. In some cases, for example, when using a Git client such as Git Tower or GitKraken, cherry-picking, rebasing or in a CI pipeline, you may want to disable githooks, especially the interactive CLI.

For skipping the interactive CLI when committing, set the environment variable SKIP_CZ_CLI to true.

$ export SKIP_CZ_CLI=true

For skipping all githooks, set the environment variable HUSKY to 0.

$ export HUSKY=0

In a CI pipeline, the githooks are skipped by default.

If you are familiar with the layout of this repository we recommend to open the repository in Stackblitz with the following button. If you created an account there and linked it to your GitHub account, you can also push edits directly to GitHub:

Pushing changes directly to the repository is not possible currently. You must fork the repository to your account instead and submit the Pull Request from there!

Every page has a Edit this page link at the bottom which takes you to a specialized editor called Web Publisher.

There, you can edit the page directly and see the changes.

Pushing changes directly to the repository is not possible currently. You must fork the repository to your account instead and submit the Pull Request from there!

⚠️IMPORTANT: Does not work for pages with a whitespace (%20) in the URL. For them the whole repository will be opened in the Stackblitz editor.