ArchiveBox/.github/ISSUE_TEMPLATE/3-documentation_change.yml

53 lines
1.9 KiB
YAML
Raw Normal View History

2024-11-03 00:05:46 +00:00
name: 📑 Documentation improvement
description: Submit an idea or correction for the Wiki documentation
2024-11-02 23:50:34 +00:00
title: "Documentation: ..."
2024-11-02 23:49:09 +00:00
labels: 'touches: docs'
2024-11-02 23:48:51 +00:00
type: 'Enhancement'
assignees:
- pirate
body:
- type: markdown
attributes:
value: |
2024-11-02 23:52:54 +00:00
If you prefer, you can submit a [Pull Request](https://github.com/ArchiveBox/docs) on https://github.com/ArchiveBox/docs to edit the docs directly instead.
- type: input
id: page_url
validations:
required: true
attributes:
2024-11-02 23:52:35 +00:00
label: "What is the URL of the page you'd like to see improved?"
2024-11-02 23:48:51 +00:00
placeholder: e.g. https://github.com/ArchiveBox/docs/wiki/Install
- type: input
id: section_title
validations:
required: true
attributes:
2024-11-02 23:52:35 +00:00
label: "What is the title of the relevant section?"
2024-11-02 23:48:51 +00:00
placeholder: e.g. Option B. Automatic Setup Script
- type: textarea
id: suggested_edit
attributes:
2024-11-02 23:52:35 +00:00
label: "What is the suggested edit?"
placeholder: |
2024-11-02 23:48:51 +00:00
e.g. Please document how to run the automatic setup script for ArchiveBox on TempleOS.
2024-11-02 23:52:35 +00:00
Attach images, screenshots, code snippets, etc. anything you think would help.
validations:
required: true
- type: markdown
attributes:
value: |
---
2024-11-02 23:50:34 +00:00
We strive to address issues as quickly as possible, it usually takes us *about a ~week* to respond.
In the meantime please consider:
- 💰 [Donating to support ArchiveBox open-source](https://github.com/ArchiveBox/ArchiveBox/wiki/Donations)
- 👨‍✈️ [Hiring us for corporate deployments](https://docs.monadical.com/s/archivebox-consulting-services) with professional support, custom feature development, and help with CAPTCHAs/rate-limits
2024-11-02 23:52:35 +00:00
- 🔍 [Checking out the new ReadTheDocs Documentation](https://docs.archivebox.io/)
- ✨ Helping us test a newer [`BETA` release](https://github.com/ArchiveBox/ArchiveBox/releases)