Welcome to the Seam Docs.
This repository hosts both the documentation source along with supporting tools.
The entire documentation site is hosted by GitBook under /docs
.
/docs
./docs
are synced back to GitBook.The Seam SDK Playground is a one-click development environment for experimenting with the Seam SDK and Seam CLI.
Each folder in /seam-sdk-playground
is a minimal
example for running the Seam SDK in a supported programming language.
By default, the SDK is configured to make requests to
a fake version of the Seam API, however you may
update the code sample to use your sandbox or production workspace.
There are a few ways to use the Seam SDK Playground:
/seam-sdk-playground
directory.Some documentation content, such as the API reference pages,
are automatically generated and updated in /docs
.
See the Development section below
for how to contribute to the documentation generation tool.
/src
.$ git clone https://github.com/seamapi/docs.git
$ cd api-docs
$ nvm install
$ npm install
$ npm run build
Primary development tasks are defined under scripts
in package.json
and available via npm run
.
View them with
$ npm run
The source code is hosted on GitHub. Clone the project with
$ git clone git@github.com:seamapi/docs.git
You will need Node.js with npm and a Node.js debugging client.
Be sure that all commands run under the correct Node version, e.g., if using nvm, install the correct version with
$ nvm install
Set the active version for each shell session with
$ nvm use
Install the development dependencies with
$ npm install
These tools are using to format code during documentation generation. They are not required for local development: if they are not installed, the doc generation will simply skip the formatting step. GitHub actions will automatically ensure the formatting is applied for all pull requests.
GitHub Actions should already be configured: this section is for reference only.
The following repository secrets must be set on GitHub Actions:
GH_TOKEN
: A personal access token for the bot user with contents:write
permission.GIT_USER_NAME
: The GitHub bot user's real name.GIT_USER_EMAIL
: The GitHub bot user's email.GPG_PRIVATE_KEY
: The GitHub bot user's GPG private key.GPG_PASSPHRASE
: The GitHub bot user's GPG passphrase.If using squash merge, edit and ensure the commit message follows the Angular Commit Message Conventions specification. Otherwise, each individual commit must follow the Angular Commit Message Conventions specification.
git checkout -b my-new-feature
).git commit -am 'Add some feature'
).git push origin my-new-feature
).Copyright (c) 2021-2024 Seam Labs, Inc.
This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.