> For the complete documentation index, see [llms.txt](https://shoppinpal.gitbook.io/docs-shoppinpal-com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://shoppinpal.gitbook.io/docs-shoppinpal-com/appendix/sequence-diagrams.md).

# Sequence Diagrams

## What are they?

## Resources

* [Visual Syntax for Sequence Diagrams](https://www.smartdraw.com/sequence-diagram/#sequenceDiagramNotations)
* Generators with a domain specific language to draw them:
  * <http://sequencediagram.org/>
  * <https://www.websequencediagrams.com/>
  * \[WINNER] Mermaid: <https://knsv.github.io/mermaid/#activations>
  * <https://bramp.github.io/js-sequence-diagrams/>
    * [GitHub project](https://github.com/bramp/js-sequence-diagrams)

      > A simple javascript library to turn text into vector UML sequence diagrams. Heavily inspired by websequencediagrams.com, who offer a serverside solution. We use Jison to parse the text, and Snap.svg to draw the image.
* GitBook plugins for generating sequence diagrams:
  * <https://github.com/gmassanek/gitbook-plugin-js-sequence-diagram>
    * <https://github.com/gmassanek/gitbook-plugin-js-sequence-diagram/issues/4>
  * \[WINNER] <https://github.com/JozoVilcek/gitbook-plugin-mermaid>
* Animate Sequence diagrams
  * This [video](https://youtu.be/UJxIPCylCos?t=4) suggests that someone accomplished this task, just not sure how, need to look deeper.
  * This [gist](https://gist.github.com/jzaeske/e2de8b14142818f8d8f5e74e8b6ae2b0) again suggests that someone was able to animate the sequence diagram in `reveal.js`
  * This [issue](https://github.com/hakimel/reveal.js/issues/1906) doesn't have to do with animations but it suggests that people often embed and use sequence diagrams with `reveal.js`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://shoppinpal.gitbook.io/docs-shoppinpal-com/appendix/sequence-diagrams.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.