Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 3.64 KB

README.md

File metadata and controls

85 lines (59 loc) · 3.64 KB
Raw

Intro

This repo serves wiki.seasalt.ai. Wiki is product documentation/user manual for non-technical Seasalt.ai customers.

How to Develop?

Doks

To get started with development, follow Doks. To modify and extend components of Doks, go to detailed documentation.

Hugo

Article Format

--- can be replaced to +++ or {}

---
title: "Introduction"
description: "Discover how SeaChat empowers you to build and launch AI agents in under 10 minutes. With support for 30+ document types and seamless integrations, including web chat, SMS, CRM, and more, SeaChat offers multilingual capabilities and a code-free experience. Learn to create your first agent with our comprehensive tutorial"
date: 2024-03-08 10:43:51.069 +0100
lastmod: 2024-03-08 10:43:51.069 +0100
weight: 201
draft: false
images: []
aliases:
  - /en/seachat/seachat-intro/01-introduction/
  - /seachat/seachat-intro/01-seachat-intro/
---

This is simple page content...

Default attributes:

  • title - the title for the content.
  • date - the datetime assigned to this page
  • draft - if true, the content will not be rendered

Other attributes:

  • lastmod - By default, the lastmod will be updated to git commit time. If you want to manually set the lastmod, you can still do so in the front matter of the page, but the value will be overwritten by the git commit time. Check here for more details.
  • description - the description for the content, for SEO purpose.
  • aliases - the path to the content from the web root.
  • weight - used for ordering your content in lists. Lower weight gets higher precedence. So content with lower weight will come first. If set, weights should be non-zero, as 0 is interpreted as an unset weight.

Develop Locally

  1. Run npm install to install all required npm packages.
  2. Run npm run start. Doks will start the Hugo development webserver accessible by default at http://localhost:1313. Saved changes will live reload in the browser.

To preview the static files that will be generated, run hugo and check /public. Open /public/index.html to see result.

Pagefind

This repo uses Pagefind to enable the searching feature. Pagefind is a search engine for static sites. It indexes your site and provides a search bar to search through your content.

How to Update Pagefind Index?

Pagefind uses indices to search for content. Pagefind will index the content in the content directory and generate the pagefind-entry.json file in the /public/pagefind/ directory. The following is the actual process that happens when you run npm run start:

  1. Build the Hugo project
hugo
  1. Generate the indexing files
npx pagefind --site ./public # this will generate the indexing and configuration files inside /pagefind in the public directory
  1. Run project server
hugo server

Note: The above process has been implemented in the CI script:

npm run prestart # strongly recommended to run this command before starting the project to ensure the indexing content for pagefind is up-to-date
npm run start

Deployment

To deploy your changes, make a PR to merge changes to main branch as usual. When your code is merged to main branch, Github Actions for deployment (see .github/workflows/deploy-github.yml) will be triggered to rebuild and publish static files to gh-pages branch. The webpage, wiki.seasalt.ai, serves the static files that are pushed to gh-pages directly.