Skip to content

Commit

Permalink
Working further on the documentation (#472)
Browse files Browse the repository at this point in the history
* Help.md: added the "Integrated Terminal" section

* Help.md: added the `Searching for Files` section.

* Docs: Reduced the depth level of sections in Help.md. Added a table of contents to the PDF version. Removed the cautious note about the documentation.

* Added a Documentation issue type
  • Loading branch information
mikekazakov authored Dec 14, 2024
1 parent b71b74d commit 0c7f3ae
Show file tree
Hide file tree
Showing 6 changed files with 108 additions and 51 deletions.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/4-doc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: 📚 Documentation
description: Something is incorrect or missing in the documentation?
title: "[Doc]: "
labels: ["documentation"]
body:
- type: textarea
id: description
attributes:
label: What is the documentation issue?
description: Describe the problem or provide your suggestions for improving the documentation.
validations:
required: true
- type: textarea
id: extra
attributes:
label: Proposed Solution
description: What changes would resolve this issue? Where should these updates appear? Sharing ideas helps ensure the documentation meets user needs effectively.
validations:
required: false
Binary file added Docs/Help-panel-findfiles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Docs/Help-terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 0c7f3ae

Please sign in to comment.