Skip to content
Open
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
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Documentation bug
about: Report a mistake, broken link, or outdated content on the docs site
title: ''
labels: ''
assignees: ''

---

**Affected page(s)**
URL(s) of the page(s) with the issue, e.g. `https://dev.ambrosiapay.com/docs/API/Authentication`.

**Locale**
- [ ] Spanish (es)
- [ ] English (en)
- [ ] Both

**What's wrong**
A clear and concise description of what is incorrect, missing, or broken (typo, outdated instructions, broken link, rendering issue, etc.).

**Expected content**
What the page should say or show instead.

**Browser / environment (if it's a rendering or search bug)**
- Browser: [e.g. Chrome, Firefox]
- Device: [e.g. desktop, mobile]

**Additional context**
Add any other context or screenshots about the problem here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Ambrosia POS application bug
url: https://github.com/olympus-btc/ambrosia/issues/new/choose
about: Found a bug in the POS app itself (client, server, or Electron), not in these docs? Report it in the main repository instead.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for the documentation site
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen (new docs section, site feature, translation, etc.).

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or content you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
20 changes: 20 additions & 0 deletions .github/workflows/dependency_review.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Dependency Review

on:
pull_request:
branches:
- main
- development

permissions:
contents: read

jobs:
dependency-review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1

- uses: actions/dependency-review-action@a1d282b36b6f3519aa1f3fc636f609c47dddb294 # v5.0.0
with:
fail-on-severity: high
45 changes: 3 additions & 42 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,54 +4,15 @@
.idea
*.iml
*.code-workspace
.changelog
.history

node_modules
.yarn
package-lock.json
npm-debug.log*

.eslintcache

yarn-error.log
website/build
coverage
.docusaurus
.cache-loader
types
test-website
test-website-in-workspace

packages/create-docusaurus/lib/
packages/lqip-loader/lib/
packages/docusaurus/lib/
packages/docusaurus-*/lib/*
packages/eslint-plugin/lib/
packages/stylelint-copyright/lib/

website/netlifyDeployPreview/*
website/changelog
!website/netlifyDeployPreview/index.html
!website/netlifyDeployPreview/_redirects

website/_dogfooding/_swizzle_theme_tests

CrowdinTranslations_*.zip

website/.cpu-prof

website/i18n/**/*
#!website/i18n/fr
#!website/i18n/fr/**/*

.netlify

website/rspack-tracing.json
website/rspack-tracing.pftrace
website/bundler-cpu-profile.json
website/profile.json.gz

.docusaurus
build
coverage

# AI Generated files
CLAUDE.md
Expand Down
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
contact@ambrosiapay.com.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
134 changes: 134 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
# Contributing to Ambrosia POS Docs

Thank you for your interest in contributing to the Ambrosia POS documentation portal! This repository (`ambrosia-dev`) holds the Docusaurus site that documents the Ambrosia POS API, the `phoenixd` integration, and developer guides. If you're looking to contribute to the POS application itself (client, server, or Electron app), see **[olympus-btc/ambrosia](https://github.com/olympus-btc/ambrosia)** instead.

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [Getting Started](#getting-started)
- [How to Contribute](#how-to-contribute)
- [Development Setup](#development-setup)
- [Content Conventions](#content-conventions)
- [Internationalization (i18n)](#internationalization-i18n)
- [Versioning](#versioning)
- [Commit Message Format](#commit-message-format)
- [Pull Request Process](#pull-request-process)
- [Issue Reporting](#issue-reporting)
- [Other Ambrosia Repositories](#other-ambrosia-repositories)

## Code of Conduct

This project adheres to our **[Code of Conduct](CODE_OF_CONDUCT.md)**. By participating, you are expected to uphold this code. Please report unacceptable behavior to **contact@ambrosiapay.com**.

## Getting Started

### Prerequisites

- **Node.js** (>= 24, see `engines` in `package.json`)
- **npm**

### First-time Contributors

If you're new to open source, check out:
- [First Contributions](https://github.com/firstcontributions/first-contributions)
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)

## How to Contribute

- 🐛 **Report bugs**: broken links, typos, outdated instructions, rendering issues.
- 📝 **Improve docs**: clarify existing pages, add missing endpoints, fix examples.
- 🌐 **Help with translations**: the site is bilingual (Spanish/English) — see [Internationalization](#internationalization-i18n).
- 💡 **Suggest new sections or guides** you think are missing.

### Before You Start

1. **Search existing issues** to avoid duplicates.
2. **Discuss major restructuring** (new sidebar sections, navigation changes) by opening an issue first.

## Development Setup

1. **Fork the repository** on GitHub.
2. **Clone your fork** locally:
```bash
git clone https://github.com/YOUR-USERNAME/ambrosia-dev.git
cd ambrosia-dev
```
3. **Install dependencies**:
```bash
npm install
```
4. **Start the dev server**:
```bash
npm start
```
Opens `http://localhost:3000` with live reload.

> **Note:** Search is not available in dev mode. To test search, run `npm run build && npm run serve` instead.

## Content Conventions

- Documentation pages live under `docs/` and are written in **MDX** (Markdown + React components).
- Blog posts live under `blog/`.
- Homepage/landing page sections are modular React components under `src/components/`.
- Styling uses **Tailwind CSS** (`tailwind.config.js`); avoid adding large custom CSS blocks to `src/css/custom.css` when a Tailwind utility will do.
- Use `lucide-react` for icons, for consistency with the rest of the site.

## Internationalization (i18n)

The site supports Spanish (`es`, the default/authored locale) and English (`en`).

- Write new documentation directly in Spanish under `docs/`. English translations live under `i18n/en/docusaurus-plugin-content-docs/current/`.
- UI strings (navbar, buttons, etc.) go in `i18n/en/code.json`.
- Run `bash scripts/find_unused_translations.sh` to find stale/unused keys in `code.json`.
- **Avoid running `npm run write-translations` without `--locale en`** — it creates an unneeded `i18n/es/` folder (Spanish is authored directly, not extracted). Even with `--locale en`, it strips the hand-written `description` fields from `i18n/en/code.json`. Prefer editing the i18n JSON files by hand.

## Versioning

Docs are versioned using Docusaurus's native versioning:

- `docs/` (labeled "Next 🚧") is where in-progress documentation for the upcoming release is written.
- `versioned_docs/version-X.Y.Z/` holds frozen documentation for a released product version — only edit these to backport a fix, not to add new content.

When cutting a new version, use `npm run docusaurus docs:version <version>` and update `lastVersion` in `docusaurus.config.js`.

## Commit Message Format

We use [Conventional Commits](https://www.conventionalcommits.org/):

```
type(scope): description
```

Examples:
- `docs(api): document new webhook payload fields`
- `fix(i18n): correct broken English translation key`
- `chore(deps): bump docusaurus to 3.10.2`

## Pull Request Process

1. **Create a branch** for your change (`git checkout -b docs/amazing-improvement`).
2. **Make your changes** and commit them.
3. **Run `npm run build`** to make sure the site still builds cleanly.
4. **Push to your fork** and open a Pull Request against `development`.

### Checklist

- [ ] Content is accurate and, where applicable, translated (or a translation gap is called out in the PR)
- [ ] `npm run build` succeeds
- [ ] No broken internal links or images
- [ ] Documentation is updated if behavior described elsewhere changed

## Issue Reporting

- **Documentation bugs**: use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) — include the affected page URL and locale.
- **Feature requests**: use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md).
- **POS application bugs**: report them on [olympus-btc/ambrosia](https://github.com/olympus-btc/ambrosia/issues) instead.

## Other Ambrosia Repositories

- [olympus-btc/ambrosia](https://github.com/olympus-btc/ambrosia) — the POS application (client, server, Electron app).
- [olympus-btc/ambrosia-tutorial](https://github.com/olympus-btc/ambrosia-tutorial) — step-by-step tutorial project.

## Community

Follow us on our social media and join the community of developers and entrepreneurs building the future of Bitcoin payments.
Loading