Skip to main content

Notebooks

đź“Ś If you have any questions shoot us an email or join us on Discord! đź’ś

Overview​

System and software architecture documentation is a guide to the structure of your system, your past architectural decisions, your best practices and guiding principles.

With Notebooks you can document and centralize all your system requirements docs, system design decisions, Architectural Decision Records (ADRs), Architecture Technical Debt (ATD), etc.

Create a Notebook​

  • Open your project
  • In the left-side menu, open “Notebooks”
  • Click “Create a notebook”
  • Type the notebook name
  • Select "Notebook”
  • Click “Create a new notebook”

You can edit your notebook at any point after its creation, all changes are autosaved.

Edit a Notebook​

Similar to any Google or Notion documention you can edit:

  • Font style and color
  • Add inline or document wide comments
  • Review the version history and revert to an older version

Create Executable Blocks​

Executable blocks allow you to combine documentation, API calls, and code snippets and execution all in one place.

Executable Code Blocks

Executable code blocks let you execute JavaScript code and see the results inline.

  1. Use the slash menu to insert a code block.
  2. Write Code. The block uses Monaco Editor to provide a code-editing experience with autocompletion.
  3. Click the “Run” button within the block to execute the code. The QuickJS runtime evaluates the code, and the output or errors are displayed below the block.

ℹ️ Pro Tip: Use results from code blocks as inputs for other API or code blocks, creating seamless data flows across your Notebook. Just mention the code block name in the relevant blocks.

Executable API Blocks

Executable API blocks let you test and document REST API calls interactively.

  1. Use the slash menu to add an API block.

  2. Configure the API request. Specify the method (GET, POST, etc.), URL, headers, and body directly in the block.

  3. Click the “Run” button to make the request. The response is displayed below the block, showing response data and headers.

ℹ️ Pro Tip: Use results from API blocks as inputs for other API or code blocks, creating seamless data flows across your Notebook. Just mention the API block name in the relevant blocks.

Delete a Notebook​

  • Open your project
  • In the left-side menu, open "Notebook”
  • Click on the ellipsis button “…” for the notebook you want to delete
  • Select “Delete”
  • Confirm your action in the prompt - please note that you can’t undo or recover deleted notebooks.

Next Steps​

You did it! What’s next?