mirror of
https://github.com/johannesjo/super-productivity.git
synced 2026-07-17 16:37:43 +00:00
Housekeeping for various docs, templates, and actions (#7451)
* chore: change Claude doc directives Ensure docs are not only aimed at end users but also that they aren't too myopic. DeepWiki can provide limitless detail on any topic. * chore(ci): switch stalesweeper to a hash reference * chore(ci): decrease frequency of discussion pruning * chore(ci): fix "unanswered" logic for stale discussions Close answered Q&A after 90 days as RESOLVED. Close everything else after 180 days as OUTDATED. * chore: clean up issue templates wrt docs Also, invert the expected-observed order for bug report.
This commit is contained in:
parent
1d1b49d337
commit
cbc6cbaa73
4 changed files with 18 additions and 27 deletions
21
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
21
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -13,15 +13,6 @@ body:
|
|||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: Tell us what should happen.
|
||||
placeholder: "e.g. When I click the 'Save' button, the data should be saved without errors."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: current-behavior
|
||||
attributes:
|
||||
|
|
@ -31,6 +22,15 @@ body:
|
|||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: Tell us what should happen.
|
||||
placeholder: "e.g. When I click the 'Save' button, the data should be saved without errors."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps-to-reproduce
|
||||
attributes:
|
||||
|
|
@ -69,9 +69,8 @@ body:
|
|||
- type: checkboxes
|
||||
id: docs-impact
|
||||
attributes:
|
||||
label: documentation gap
|
||||
label: Documentation
|
||||
description: Optionally, indicate whether documentation updates are needed.
|
||||
options:
|
||||
- label: The documentation/[wiki](https://github.com/super-productivity/super-productivity/wiki) is unclear or incorrect for this case.
|
||||
- label: There should be a note added to the documentation/[wiki](https://github.com/super-productivity/super-productivity/wiki) for this case.
|
||||
- label: I can help improve the documentation.
|
||||
|
|
|
|||
9
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
9
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
|
@ -47,12 +47,3 @@ body:
|
|||
placeholder: 'Add links to related issues, screenshots, mockups, or any other relevant information.'
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: docs-impact
|
||||
attributes:
|
||||
label: documentation gap
|
||||
description: Help us keep docs aligned with proposed changes. If this feature is implemented ...
|
||||
options:
|
||||
- label: ... related docs should be updated as part of the same PR whenever possible.
|
||||
- label: ... I can help improve the documentation.
|
||||
|
|
|
|||
10
.github/workflows/stale-discussions.yml
vendored
10
.github/workflows/stale-discussions.yml
vendored
|
|
@ -3,7 +3,7 @@ name: Close Stale Discussions
|
|||
|
||||
'on':
|
||||
schedule:
|
||||
- cron: '0 0 * * *'
|
||||
- cron: '0 0 * * 1'
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
days-before-close:
|
||||
|
|
@ -24,14 +24,14 @@ jobs:
|
|||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: stalesweeper
|
||||
uses: zenoprax/stalesweeper@v1.1.2
|
||||
uses: zenoprax/stalesweeper@c9c72ef0504f835bf9bf8ed7319d3bc149539291 # v1.1.2
|
||||
env:
|
||||
DAYS_BEFORE_CLOSE: ${{ github.event_name == 'schedule' && '180' || github.event.inputs.days-before-close }}
|
||||
DRY_RUN: ${{ github.event_name == 'schedule' && 'false' || github.event.inputs.dry-run }}
|
||||
with:
|
||||
categories: ''
|
||||
close-reason: 'OUTDATED'
|
||||
close-unanswered: 'false'
|
||||
close-unanswered: 'true'
|
||||
days-before-close: '${{ env.DAYS_BEFORE_CLOSE}}'
|
||||
dry-run: ${{ env.DRY_RUN }}
|
||||
exempt-labels: 'documentation gap'
|
||||
|
|
@ -43,14 +43,14 @@ jobs:
|
|||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: stalesweeper
|
||||
uses: zenoprax/stalesweeper@v1.1.2
|
||||
uses: zenoprax/stalesweeper@c9c72ef0504f835bf9bf8ed7319d3bc149539291 # v1.1.2
|
||||
env:
|
||||
DAYS_BEFORE_CLOSE: ${{ github.event_name == 'schedule' && '90' || github.event.inputs.days-before-close }}
|
||||
DRY_RUN: ${{ github.event_name == 'schedule' && 'false' || github.event.inputs.dry-run }}
|
||||
with:
|
||||
categories: 'Q&A'
|
||||
close-reason: 'RESOLVED'
|
||||
close-unanswered: 'true'
|
||||
close-unanswered: 'false'
|
||||
days-before-close: '${{ env.DAYS_BEFORE_CLOSE}}'
|
||||
dry-run: ${{ env.DRY_RUN }}
|
||||
exempt-labels: 'documentation gap'
|
||||
|
|
|
|||
|
|
@ -21,7 +21,8 @@ The `docs/wiki/` directory is the manually curated, human-focused wiki that ship
|
|||
| New theming hook or theme variable change | `3.09-Theming.md` |
|
||||
| Web vs desktop capability differences | `3.05-Web-App-vs-Desktop.md` |
|
||||
|
||||
If a change does not map to any of the above and is purely internal (refactor, test, perf, build), no wiki update is needed.
|
||||
If a change is purely internal (eg. refactor, test, perf, build), no wiki update is needed.
|
||||
Some subsystems may be so specific that code comments alone would suffice; in this case no wiki update is needed unless it directly contradicts what has already been written.
|
||||
|
||||
## How to write wiki content
|
||||
|
||||
|
|
@ -43,4 +44,4 @@ Wiki notes are linted in CI before being synced to GitHub Wiki. See [`docs/wiki/
|
|||
|
||||
## Developer-facing docs
|
||||
|
||||
The wiki is for end users. Developer-facing docs (`docs/styling-guide.md`, `docs/sync-and-op-log/`, `docs/plugin-development.md`, `ARCHITECTURE-DECISIONS.md`) follow the same "update alongside the code" rule when their subject changes.
|
||||
The wiki is for both end-users and developers. There are still developer-facing docs (`docs/styling-guide.md`, `docs/sync-and-op-log/`, `docs/plugin-development.md`, `ARCHITECTURE-DECISIONS.md`) which are either too old or too new to have been considered for integration into the wiki. Regardless, follow the same "update alongside the code" rule when those notes requires changes and point out when they can be integrated into the main wiki. Never refactor them into the new wiki without warning as some devs may be relying on them in their current location.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue