Skip to content

Commit

Permalink
Enable changelog documentation (#552)
Browse files Browse the repository at this point in the history
* Changelog init commit

* changing docker compose config to incorporate changelog builds
  • Loading branch information
zerismo authored Sep 5, 2024
1 parent d2f5a8d commit 703a34e
Show file tree
Hide file tree
Showing 12 changed files with 172 additions and 0 deletions.
6 changes: 6 additions & 0 deletions changelog/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# rename this file to .env and fill in the values

# Github personal access token that has access to the repo provided below.
GITHUB_TOKEN=
# should be account-name/repo-name (e.g. "fennel-ai/my-repo")
GITHUB_REPO=
7 changes: 7 additions & 0 deletions changelog/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.env
examples/**.json
.vscode
venv/
**/__pycache__/*
.idea/
wordlist.dic
8 changes: 8 additions & 0 deletions changelog/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
build:
docker-compose build --no-cache
up:
docker-compose up
test: # run the tests on the examples directory
echo "Not Implemented Yet!"
check: # here we can check validity of markdown, enforce our own rules e.g. only one <h1> as the first element, run prettier on .md/.mdx etc.
echo "Not Implemented Yet!"
22 changes: 22 additions & 0 deletions changelog/algolia.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"index_name": "docsearch_prod",
"start_urls": [
"https://fennel.ai/docs"
],
"sitemap_urls": [
"https://fennel.ai/docs/sitemap.xml"
],
"selectors": {
"lvl0": {
"selector": "#section_title",
"global": true,
"default_value": "Documentation"
},
"lvl1": "main h1",
"lvl2": "main h2, main p#page_description",
"lvl3": "main h3",
"lvl4": "main h4",
"lvl5": "main h5",
"text": "main p:not(#section_title)"
}
}
9 changes: 9 additions & 0 deletions changelog/assets/illustrations/cicd.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions changelog/assets/illustrations/getting-started.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions changelog/assets/illustrations/lookups.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 703a34e

Please sign in to comment.