Skip to content
Merged
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
11 changes: 4 additions & 7 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
target-branch: "canary"
open-pull-requests-limit: 5
1 change: 1 addition & 0 deletions .github/funding.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: ["@builtbyjonas"]
12 changes: 6 additions & 6 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[submodule "examples/next"]
path = examples/next
url = https://github.com/binary-blazer/contentkit-next-blog-demo.git
[submodule "examples/javascript"]
path = examples/javascript
url = https://github.com/binary-blazer/contentkit-js-demo.git
[submodule "examples/next"]
path = examples/next
url = https://github.com/binary-blazer/contentkit-next-blog-demo.git
[submodule "examples/javascript"]
path = examples/javascript
url = https://github.com/binary-blazer/contentkit-js-demo.git
14 changes: 7 additions & 7 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
node_modules
distribution
LICENSE
README.md
pnpm-lock.yaml
pnpm-workspace.yaml
.next
node_modules
distribution
LICENSE
README.md
pnpm-lock.yaml
pnpm-workspace.yaml
.next
.contentkit
56 changes: 28 additions & 28 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
BSD 3-Clause License

Copyright (c) 2025, Jonas Franke

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

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.
BSD 3-Clause License
Copyright (c) 2025, Jonas Franke
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
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.
11 changes: 11 additions & 0 deletions docs/.github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Code of Conduct (Docs)

This project adheres to the **Resonix Code of Conduct**.

To view the canonical, up-to-date version, see the repository root [CODE_OF_CONDUCT.md](https://github.com/resonix-dev/resonix-node/blob/master/CODE_OF_CONDUCT.md).

> Any unacceptable behavior within documentation contributions (issues / PRs / discussions) should be reported per the instructions in the root policy.

If you are viewing this in a published documentation site, follow this link:

- https://github.com/resonix-dev/resonix-node/blob/master/CODE_OF_CONDUCT.md
38 changes: 38 additions & 0 deletions docs/.github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing to Resonix Docs

The primary contributing guide lives at the repository root: [CONTRIBUTING.md](https://github.com/resonix-dev/resonix-node/blob/master/CONTRIBUTING.md).

This file exists to clarify documentation-specific expectations:

## Docs-Specific Guidelines

- Maintain parity between `en/` and `de/` folders. If translation is pending, clearly mark it.
- Favor short paragraphs and descriptive headings.
- Use fenced code blocks with explicit language identifiers (e.g. `rust`, `bash`, `json`).
- Keep link titles descriptive; avoid raw URLs except in reference lists.
- Prefer present tense and active voice.

## Process

1. Fork & branch from `development`.
2. Make doc changes.
3. Run local preview to ensure no build errors.
4. Open a Pull Request with:
- Summary of changes
- Screenshots if UI / theme related
- Checklist of translated pages (if applicable)
5. Respond to review feedback.

## Style Consistency

- Use American English in `en/` by default.
- Keep headings in sentence case (capitalize only first word and proper nouns) unless conventional (e.g. API, HTTP).
- Avoid trailing whitespace; wrap lines at ~100–120 chars where practical.

## Tooling

VitePress & Markdown linting can be added later; feel free to propose enhancements.

For general project contribution (tests, code style, commit message format), see the root guide:

- https://github.com/resonix-dev/resonix-node/blob/master/CONTRIBUTING.md
32 changes: 32 additions & 0 deletions docs/.github/GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Project Governance (Summary for Docs)

The canonical governance (if formalized) resides in root docs or organizational policy. This document summarizes how decisions affecting documentation are generally made.

## Roles

- Maintainers: Merge PRs, publish releases, curate roadmap.
- Contributors: Open issues/PRs, help review translations.
- Reviewers (optional pool): Provide focused feedback on specialized areas (audio pipeline, API design, localization).

## Decision Making

- Small doc fixes: Merged by a single maintainer after basic review.
- Structural changes (navigation, IA): Require consensus of at least 2 maintainers (or lazy consensus after 5 business days).
- Policy documents: Mirror root repository; changes happen centrally.

## Transparency

All substantial decisions should be documented in PR descriptions or linked issues for traceability.

## Escalation

If you disagree with a docs decision, open an issue labeled `governance` summarizing:

- Context
- Decision made
- Alternative proposal
- Rationale & trade-offs

## Evolution

As the project grows, a more formal charter may replace this summary. Suggestions welcome via PR.
49 changes: 49 additions & 0 deletions docs/.github/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Resonix Documentation

Welcome to the documentation source for **Resonix**.

This `docs` folder contains the multilingual (currently `en` and `de`) content for the site built with [VitePress](https://vitepress.dev/).

## Quick Start (Local Preview)

1. Install dependencies (uses `pnpm`):
```bash
pnpm install
pnpm dev
```
2. Open the local dev URL printed in the terminal.

## Structure

- `.vitepress/` – VitePress config & theme overrides
- `en/` / `de/` – English & German content
- `LICENSE` – License for documentation content

## Contributing to the Docs

Please read [CONTRIBUTING.md](./CONTRIBUTING.md) in this folder. In short:

- For substantial structural/content changes, open an issue first.
- Keep language parity: when adding or changing an English page, create/update the German counterpart (or add a TODO note inside it).
- Use inclusive language and concise examples.
- Prefer relative links; avoid absolute GitHub URLs unless necessary.

## Translation Workflow

1. Update the English page.
2. Duplicate to `de/` and translate.
3. If translation will follow later, add at the top:
```md
> :warning: This page is pending translation. Contributions welcome!
```
4. Open a PR referencing the issue (if any).

## License

All documentation content is licensed under the same license as the main project.

> BSD-3-Clause

## Feedback

Please open an issue in the main repository for suggestions, typos, or structural improvements.
17 changes: 17 additions & 0 deletions docs/.github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Security Policy (Docs)

The authoritative security policy is maintained at the repository root: [SECURITY.md](https://github.com/resonix-dev/resonix-node/blob/master/SECURITY.md).

Please read that file for:

- Supported versions / release lines
- How to report a vulnerability (private disclosure process)
- Expected response timelines

Direct link:

- https://github.com/resonix-dev/resonix-node/blob/master/SECURITY.md

## Documentation-Specific Notes

If you discover a security issue within the documentation site infrastructure (build pipeline, published assets) rather than the application code, you may still use the same private disclosure channel. Please clearly state in your report that the issue concerns the documentation delivery mechanism.
27 changes: 27 additions & 0 deletions docs/.github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Support

Need help with Resonix?

## Channels

| Topic | Where | Notes |
| ----------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| General usage questions | GitHub Discussions (if enabled) / Issues (question label) | Search first to avoid duplicates |
| Bug reports | GitHub Issues | Include reproduction steps, expected vs actual behavior |
| Security concerns | See [SECURITY.md](https://github.com/resonix-dev/resonix-node/blob/master/SECURITY.md) | Use private disclosure channel only |
| Feature requests | GitHub Issues / Discussions | Provide motivation & alternatives considered |
| Documentation gaps | Pull Request or Issue | Screenshots helpful for visual issues |

## Before You Ask

1. Check existing issues & docs search.
2. Verify you are on a supported version.
3. Reproduce with minimal steps or a small test snippet.

## Response Expectations

This is an open-source project maintained by volunteers. Response times may vary; security reports have priority.

## Commercial / Enterprise

If you require SLAs or commercial support, open a discussion to gauge interest—this may evolve as the project grows.
3 changes: 3 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
.vitepress/dist
.vitepress/cache
3 changes: 3 additions & 0 deletions docs/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
.vitepress/cache/
.vitepress/dist/
1 change: 1 addition & 0 deletions docs/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
Loading
Loading