From fe88823060ba4f24b5bf93f6f167d50f574b4ded Mon Sep 17 00:00:00 2001
From: thiswillbeyourgithub
<26625900+thiswillbeyourgithub@users.noreply.github.com>
Date: Tue, 29 Apr 2025 11:51:54 +0200
Subject: [PATCH 1/3] whitespace
Signed-off-by: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com>
---
docs/source/index.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/source/index.rst b/docs/source/index.rst
index f1a2993c..378f8fc5 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -8,9 +8,9 @@
sections/contrib
sections/sudo
- tutorials
+ tutorials
sections/faq
-
+
.. image:: images/logo-230.png
:alt: Logo
From 8bc618a910464003d385d6a223572bdafb419bbd Mon Sep 17 00:00:00 2001
From: thiswillbeyourgithub
<26625900+thiswillbeyourgithub@users.noreply.github.com>
Date: Tue, 29 Apr 2025 12:02:04 +0200
Subject: [PATCH 2/3] doc: add full doc as a single page for LLMs
Signed-off-by: thiswillbeyourgithub
<26625900+thiswillbeyourgithub@users.noreply.github.com>
---
docs/source/fulldoc.rst | 35 ++++++++++++++++++++++++++++++++++
docs/source/index.rst | 4 ++++
docs/source/ref_to_fulldoc.rst | 6 ++++++
3 files changed, 45 insertions(+)
create mode 100644 docs/source/fulldoc.rst
create mode 100644 docs/source/ref_to_fulldoc.rst
diff --git a/docs/source/fulldoc.rst b/docs/source/fulldoc.rst
new file mode 100644
index 00000000..bcf8ad37
--- /dev/null
+++ b/docs/source/fulldoc.rst
@@ -0,0 +1,35 @@
+Full Documentation
+==================
+
+This single page repeats the full documentation for `sh `, making it easier to put into an LLM's context window. There is nothing on this page that is not mentionned already elsewhere on this site, it's just reorganized as a single page.
+
+.. include:: index.rst
+
+.. include:: tutorials/interacting_with_processes.rst
+.. include:: tutorials/real_time_output.rst
+
+
+.. content linked in index.rst
+.. include:: sections/faq.rst
+.. include:: sections/contrib.rst
+.. include:: sections/sudo.rst
+
+.. content of usage.rst
+.. include:: sections/passing_arguments.rst
+.. include:: sections/exit_codes.rst
+.. include:: sections/redirection.rst
+.. include:: sections/asynchronous_execution.rst
+.. also contains reference to example/done.rst so no need to mention it explicitely
+.. .. include:: examples/done.rst
+.. include:: sections/baking.rst
+.. include:: sections/piping.rst
+.. include:: sections/subcommands.rst
+.. include:: sections/default_arguments.rst
+.. include:: sections/envs.rst
+.. include:: sections/stdin.rst
+.. include:: sections/with.rst
+
+.. content of reference.rst
+.. include:: sections/special_arguments.rst
+.. include:: sections/architecture.rst
+.. include:: sections/command_class.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 378f8fc5..79dbc401 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -11,6 +11,8 @@
tutorials
sections/faq
+ ref_to_fulldoc
+
.. image:: images/logo-230.png
:alt: Logo
@@ -156,3 +158,5 @@ Background Processes
p.wait()
:ref:`Read More `
+
+.. include:: ref_to_fulldoc.rst
diff --git a/docs/source/ref_to_fulldoc.rst b/docs/source/ref_to_fulldoc.rst
new file mode 100644
index 00000000..ff337206
--- /dev/null
+++ b/docs/source/ref_to_fulldoc.rst
@@ -0,0 +1,6 @@
+Single Page
+===========
+
+The page below repeats the full documentation for `sh ` as a single page, making it easier to put into an LLM's context window.
+
+:doc:`./fulldoc`
From aa027643370a638c8b352dfa87538b2ec8168bae Mon Sep 17 00:00:00 2001
From: thiswillbeyourgithub
<26625900+thiswillbeyourgithub@users.noreply.github.com>
Date: Tue, 29 Apr 2025 16:30:39 +0200
Subject: [PATCH 3/3] doc: add link to the full doc in the readme
Signed-off-by: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com>
---
README.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/README.rst b/README.rst
index a5b73fbc..11a6156f 100644
--- a/README.rst
+++ b/README.rst
@@ -36,6 +36,8 @@ systems - Linux, macOS, BSDs etc. Specifically, Windows is not supported.
`Complete documentation here `_
+`Full documentation on a single page for LLM-assisted coding here `_
+
Installation
============