Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 27 additions & 8 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
name: Build

on:
pull_request_target:
pull_request:
types: [opened, synchronize, reopened]

jobs:
check-links:
runs-on: ubuntu-latest
needs: []
permissions:
pull-requests: write
contents: read
Expand All @@ -16,15 +17,33 @@ jobs:
ref: ${{ github.event.pull_request.head.sha }}

- uses: lycheeverse/lychee-action@v2
id: lychee_markets
id: lychee
with:
args: ". --exclude '^file://.*'"
fail: true

build:
uses: fiskaltrust/service-docs-ui/.github/workflows/build.yml@main
needs: check-links
with:
docs_ref: ${{ github.event.pull_request.head.sha }}
secrets:
DOCS_REPOS_READ_TOKEN: ${{ secrets.DOCS_REPOS_READ_TOKEN }}
runs-on: windows-latest
needs: []
steps:
- name: Checkout
uses: actions/checkout@v4
with:
repository: fiskaltrust/service-docs-ui
token: ${{ secrets.DOCS_REPOS_READ_TOKEN }}
submodules: true

- name: Update submodules
run: git submodule update --recursive --remote

- name: Checkout docs to specific ref
working-directory: docs
run: |
git fetch origin ${{ github.event.pull_request.head.sha }}
git checkout ${{ github.event.pull_request.head.sha }}

- name: Restore packages
run: yarn install

- name: Build site
run: yarn build
7 changes: 6 additions & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,9 @@ jobs:
with:
token: ${{ secrets.DOCS_REPOS_DISPATCH_TOKEN }}
repository: fiskaltrust/service-docs-ui
event-type: deploy-docs
event-type: update-docs
client-payload: |-
{
"sha": "${{ github.sha }}",
"repository": "${{ github.repository }}"
}
1 change: 1 addition & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@ https://www.raspberrypi.com/products/raspberry-pi-2-model-b
https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000044983827#:~:text=La%20taxe%20est%20exigible%20%3A,%C3%A0%20concurrence%20du%20montant%20encaiss%C3%A9.
https://forms\.office\.com/e/.*
https?://fiskaltrust\.../
https?://github\.com/fiskaltrust/service-docs-ui.*
64 changes: 64 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# fiskaltrust Documentation Content

This repository contains the documentation content for the [fiskaltrust documentation platform](https://docs.fiskaltrust.cloud). It is consumed as a Git submodule by [fiskaltrust/service-docs-ui](https://github.com/fiskaltrust/service-docs-ui), which uses [Docusaurus](https://docusaurus.io/) to build and deploy the site.

## Documentation Structure

The content is organized into audience-specific sections, each with its own sidebar navigation defined in a `toc.js` file.

```
.
├── poscreators/ # Technical integration guides and middleware API docs for POS system developers
├── posdealers/ # Business, onboarding and operational docs for POS resellers
├── faq/ # General reference pages (terminology, customer roles)
└── sidebars.js
```

### Sidebar Navigation

The sidebar structure is defined manually via JavaScript files rather than auto-generated from the directory layout. The root `sidebars.js` imports the sidebar definitions from `poscreators/toc.js` and `posdealers/toc.js`.

When you add, remove, or rename a page, you must update the corresponding `toc.js` file to reflect the change in the sidebar.

### Writing Documentation Pages

Each Markdown file should start with [Docusaurus front matter](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter):

```yaml
---
slug: /poscreators/my-new-page
title: My New Page
---
```

Use standard Markdown for content. Docusaurus also supports [MDX](https://docusaurus.io/docs/markdown-features) if you need React components.

Place images in an `images/` directory next to the Markdown files that reference them and use relative paths.

## Contributing

1. Fork or branch this repository.
2. Edit or add Markdown files in the appropriate section (`poscreators/`, `posdealers/`, or `faq/`).
3. Update the sidebar in the relevant `toc.js` file if you added, removed, or renamed a page.
4. Open a pull request against the `main` branch.

Every page on the live site has an "Edit this document" link at the bottom that takes you directly to the source file on GitHub.

> For instructions on previewing your changes locally in the context of the full site, see the [service-docs-ui README](https://github.com/fiskaltrust/service-docs-ui#readme).

## CI/CD

Pull requests are automatically validated with a link check ([lychee](https://github.com/lycheeverse/lychee-action)) and a full Docusaurus site build to catch broken links and build errors before merging.

When a pull request is merged to `main`, the site is automatically rebuilt and deployed to https://docs.fiskaltrust.cloud.

> For a full overview of how the workflows across all repositories fit together, see the [CI/CD Workflows section in the service-docs-ui README](https://github.com/fiskaltrust/service-docs-ui#cicd-workflows).

## Link Checking Configuration

Link checking is configured via two files:

- `lychee.toml`: general settings (timeout, retry wait time).
- `.lycheeignore`: URL patterns to exclude from checking (e.g. sandbox URLs, localhost, known false positives).

If a new external URL is consistently flagged as a false positive, add a matching pattern to `.lycheeignore`.
Loading