Skip to content
Draft
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
38 changes: 38 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# CODEOWNERS
# Defines code ownership for automatic review assignment.
# The last matching pattern takes precedence.
# See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

# Global default — core maintainers review everything
* @XRPLF/docs-maintainers

# Concepts and narrative docs
/docs/concepts/ @XRPLF/docs-maintainers

# Tutorials
/docs/tutorials/ @XRPLF/docs-maintainers

# API reference
/docs/references/ @XRPLF/docs-maintainers

# Infrastructure / node docs
/docs/infrastructure/ @XRPLF/docs-maintainers

# Code samples — require technical review
/_code-samples/ @XRPLF/docs-maintainers

# API examples
/_api-examples/ @XRPLF/docs-maintainers

# Site theme and web tooling
/@theme/ @XRPLF/docs-maintainers
/styles/ @XRPLF/docs-maintainers

# Localization files
/@l10n/ @XRPLF/docs-maintainers

# CI/CD and project configuration — maintainer-only
/.github/ @XRPLF/docs-maintainers
/redocly.yaml @XRPLF/docs-maintainers
/package.json @XRPLF/docs-maintainers
/package-lock.json @XRPLF/docs-maintainers
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: "Bug Report"
description: Report a typo, broken link, incorrect information, or other documentation error
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for helping improve the XRP Ledger documentation! Please fill out this form as completely as possible.

- type: input
id: page-url
attributes:
label: Affected Page URL
description: The URL of the page with the issue (e.g. https://xrpl.org/docs/...)
placeholder: "https://xrpl.org/docs/..."
validations:
required: true

- type: dropdown
id: bug-type
attributes:
label: Type of Issue
description: What kind of problem did you find?
options:
- Typo or grammar error
- Broken or incorrect link
- Incorrect technical information
- Outdated content
- Missing content
- Formatting or display issue
- Other
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: Describe the problem clearly. Include what is wrong and what it should say instead.
placeholder: "The page states X, but it should say Y because..."
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Content
description: What should the correct content say?
validations:
required: false

- type: input
id: source-reference
attributes:
label: Source Reference (optional)
description: Link to source code, specification, or other reference that confirms the correct information
placeholder: "https://github.com/XRPLF/rippled/..."

- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I have searched existing issues to confirm this has not already been reported
required: true
- label: I have verified this issue exists on the live site (not just locally)
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: XRP Ledger Developer Discord
url: https://discord.gg/xrpl
about: Ask questions and discuss XRP Ledger development with the community
- name: XRPL.org Feedback
url: https://xrpl.org/about/contact
about: General feedback about the XRP Ledger portal
86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/content_update.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: "Content Update"
description: Request an update, addition, or improvement to existing documentation
title: "[Content]: "
labels: ["content updates"]
body:
- type: markdown
attributes:
value: |
Use this template to request changes to existing documentation content — for example, adding new details, updating outdated information, or improving clarity.

- type: input
id: page-url
attributes:
label: Affected Page URL
description: URL of the page that needs updating (if applicable)
placeholder: "https://xrpl.org/docs/..."

- type: dropdown
id: update-type
attributes:
label: Type of Update
options:
- Add missing information
- Update outdated content
- Improve clarity or readability
- Reorganize or restructure content
- Add examples or code samples
- Other
validations:
required: true

- type: dropdown
id: content-area
attributes:
label: Content Area
description: Which area of the documentation does this affect?
options:
- Concepts
- Tutorials
- References / API
- Infrastructure / Nodes
- Tokenization / NFTs
- DEX / AMM
- Payment Channels / Escrow
- Accounts / Wallets
- Localization / Translation
- Site tooling
- Other
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: Describe what needs to be changed and why. Be as specific as possible.
placeholder: "The documentation for X needs to be updated because..."
validations:
required: true

- type: input
id: source-reference
attributes:
label: Source / Reference
description: Link to the rippled source, amendment details, XLS proposal, or other authoritative reference
placeholder: "https://github.com/XRPLF/rippled/..."

- type: dropdown
id: amendment-status
attributes:
label: Amendment Status (if applicable)
description: If this relates to a protocol amendment, what is its status?
options:
- "N/A"
- In development (not yet proposed)
- Proposed (in open voting)
- Enabled on Mainnet
- Enabled on Devnet/Testnet only

- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I have searched existing issues to avoid duplicates
required: true
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: "Feature Request"
description: Suggest a new page, section, tool, or site feature
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Use this template to suggest a new documentation page, site feature, or tooling improvement for the XRP Ledger Developer Portal.

- type: dropdown
id: feature-type
attributes:
label: Feature Type
options:
- New documentation page or section
- New interactive tool or code sample
- Site navigation or UX improvement
- Developer tooling or CI/CD improvement
- Localization support
- Other
validations:
required: true

- type: textarea
id: problem
attributes:
label: Problem to Solve
description: Describe the problem or gap this feature would address. Who would benefit?
placeholder: "As a developer building on the XRP Ledger, I need..."
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe what you'd like to see added or changed.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Have you considered any alternative approaches?

- type: dropdown
id: priority
attributes:
label: Priority (your assessment)
options:
- Low – nice to have
- Medium – would significantly improve the docs
- High – blocks common developer workflows
validations:
required: true

- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I have searched existing issues to avoid duplicates
required: true
- label: I am willing to contribute a PR for this feature
52 changes: 52 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
## Description

<!-- Provide a clear, concise description of what this PR does. -->

Fixes #<!-- issue number -->

## Type of Change

<!-- Check all that apply -->
- [ ] Bug fix (documentation typo, broken link, incorrect information)
- [ ] Content update (new information, updated existing docs)
- [ ] New page or section
- [ ] Site feature / tooling change
- [ ] Localization / translation
- [ ] Refactoring (no functional change)

## RACI Confirmation

This project follows a RACI model for contributions. Please confirm the following:

| Role | Description | Confirmed |
|------|-------------|-----------|
| **R – Responsible** | I am the author of these changes and have completed the work described above | - [ ] |
| **A – Accountable** | I understand that a maintainer must approve this PR before it can be merged | - [ ] |
| **C – Consulted** | I have tagged relevant subject-matter experts as reviewers (if applicable) | - [ ] |
| **I – Informed** | The linked issue keeps stakeholders informed of this change | - [ ] |

> See [RACI Model](.github/project-management/RACI.md) for full role definitions.

## Review Checklist

**Author (Responsible)**
- [ ] PR is linked to an open issue
- [ ] Changes are accurate and technically correct
- [ ] Content follows the [style guide](https://xrpl.org/resources/contribute-documentation/)
- [ ] All links work and point to correct targets
- [ ] Code samples (if any) have been tested
- [ ] Localization impact considered (does this need translation updates?)

**Reviewer (Accountable / Consulted)**
- [ ] Technical accuracy verified
- [ ] Writing is clear and follows style guidelines
- [ ] No broken links or missing references
- [ ] No security-sensitive information inadvertently exposed

## Screenshots (if applicable)

<!-- Add before/after screenshots for UI or formatting changes -->

## Additional Notes

<!-- Any context, decisions made, or follow-up items -->
Loading