@sous-io/sous 0.2.36 → 1.0.1

package/docs/markdown/README.md

@@ -96,10 +96,9 @@ its own question. Each is judged on its own version:
 - `--major`: the newest published version, whatever its major.
 - `--version <version|range|tag>`: exactly that version, the newest one in that range, or the one a
   dist-tag such as `next` points at. This is how you downgrade, and the plan says when it is one.
-- `--prerelease` counts prerelease versions, and is on by default when the installed version is a
-  prerelease; `--no-prerelease` switches it off.
-- `--global` or `--project` updates only that install; `-y, --yes` answers every question;
-  `--dry-run` prints the plans, with the command each would run, and installs nothing.
+
+`--dry-run` prints the plans, with the command each would run, and installs nothing. The other flags
+(prereleases, one install only, answering every question) are in `sous update --help`.
 
 A copy run through `npx`, or one managed by Volta or by a manager sous does not drive, is listed
 with the command to run by hand, and the rest are still updated. A package manager's own failure
@@ -122,4 +121,6 @@ $ sous update --global --yes
 - Look up a command in the [command reference](commands.md)
 - Work out what an error is telling you in [repositories troubleshooting](repositories-troubleshooting.md)
 - Read the [design principles](design-principles.md) that constrain every feature
+- Read [how sous 1.0 is built](architecture/laws.md): the rules, goals and design documents behind
+  it, starting with [the engine](architecture/specifications/S1-engine.md)
 - Read the [source on GitHub](https://github.com/sous-io/sous)

package/docs/markdown/_sidebar.md

@@ -18,6 +18,17 @@
   - [Providers](repositories-providers.md)
   - [File formats](repositories-file-formats.md)
   - [Troubleshooting](repositories-troubleshooting.md)
+- **How sous is built (1.0)**
+  - [Laws](architecture/laws.md)
+  - [Goals](architecture/goals.md)
+  - [Specifications](architecture/specifications/README.md)
+  - [The engine](architecture/specifications/S1-engine.md)
+  - [Building the config](architecture/specifications/S2-config-building.md)
+  - [Packaging and releases](architecture/specifications/S3-packaging-and-releases.md)
+  - [Private GitLab and switched-off subscriptions](architecture/specifications/S4-private-gitlab-and-switched-off-subscriptions.md)
+  - [Config expressions](architecture/specifications/S5-config-expressions.md)
+  - [Which plugin does what](architecture/specifications/S6-concerns-and-owners.md)
+  - [Everything sous can do](architecture/specifications/S7-capabilities.md)
 - **ADRs**
   - [0001: Repositories](adrs/0001-repositories.md)
   - [0002: Recipe answers in the template scope](adrs/0002-recipe-answers-in-templates.md)
@@ -30,5 +41,14 @@
   - [0009: One whole build, everywhere](adrs/0009-whole-build-everywhere.md)
   - [0010: The index describes each version's dependencies and questions](adrs/0010-index-describes-recipes.md)
   - [0011: `sous update` updates sous through the package managers](adrs/0011-self-update.md)
-  - [0012: Recipes do not install Sous plugins](adrs/0012-recipes-and-plugins.md)
+  - [0012: Recipes do not install Sous plugins (superseded)](adrs/0012-recipes-and-plugins.md)
   - [0013: One ref resolver, and recipe memories through a `#memories` view](adrs/0013-one-ref-resolver.md)
+  - [0014: A small engine, and everything else a plugin](adrs/0014-plugin-engine.md)
+  - [0015: The config is built by contributors, from primitive patches](adrs/0015-config-from-contributors.md)
+  - [0016: Intents, front ends as plugins, and our own CLI foundation](adrs/0016-intents-and-front-ends.md)
+  - [0017: Recipes may ship sous plugins](adrs/0017-recipes-ship-plugins.md)
+  - [0018: One project root, which sous sets](adrs/0018-one-project-root.md)
+  - [0019: Agent tools are plugins](adrs/0019-agent-tools-as-plugins.md)
+  - [0020: Config expressions](adrs/0020-config-expressions.md)
+  - [0021: Reporting as levels and styles](adrs/0021-reporting-levels-and-styles.md)
+  - [0022: Intents return outputs](adrs/0022-intents-return-outputs.md)