Skip to content

Commit 6807d53

Browse files
authored
readme: small changes
1 parent 9b48503 commit 6807d53

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,6 @@
33
explainshell is a tool (with a web interface) capable of parsing man pages, extracting options and
44
explaining a given command-line by matching each argument to the relevant help text in the man page.
55

6-
> [!IMPORTANT]
7-
> ### ⚠️ Note on Maintenance and Manpages
8-
>
9-
> This project is actively maintained in terms of keeping it healthy and functional — issues are addressed, and the core remains stable.
10-
>
11-
> However, please note that the **manpages are outdated**. The previous system for generating them was unsustainable, and they haven’t been updated in some time. There are currently **no active plans** to revise this mechanism.
12-
>
13-
> If you're relying on manpages, be aware that they may not reflect the latest behavior. Contributions in this area are welcome but would require rethinking the documentation pipeline.
14-
15-
166
## How?
177

188
explainshell is built from the following components:
@@ -37,7 +27,15 @@ When querying explainshell, it:
3727
list of known options
3828
4. returns a list of matches that are rendered with Flask
3929

40-
## Missing man pages
30+
## Manpages
31+
32+
> [!IMPORTANT]
33+
>
34+
> explainshell is actively maintained in terms of keeping it healthy and functional -- issues are addressed, and the core remains stable.
35+
>
36+
> However, please note that the **manpages are outdated**. The previous system for generating them was unsustainable, and they haven’t been updated in some time. There are currently **no active plans** to revise this mechanism.
37+
>
38+
> If you're relying on manpages, be aware that they may not reflect the latest behavior. Contributions in this area are welcome but would require rethinking the documentation pipeline.
4139
4240
Right now explainshell.com contains the entire [archive of Ubuntu](http://manpages.ubuntu.com/). It's not
4341
possible to directly add a missing man page to the live site (it might be in the future).

0 commit comments

Comments
 (0)