Skip to content

Commit e0d70dc

Browse files
initcronclaude
initcron
and
claude
committed
docs: add comprehensive user documentation, website content, and Apache 2.0 license
- Add 5-minute quickstart guide - Add core concepts page (agents, safety, plugins, presets layering) - Add 5 end-to-end workflow examples (deploy, RCA, incident, cost, Terraform) - Add complete CLI reference (wizard, safety-switch, plugin, preset) - Add troubleshooting guide with 7 common issues and 10 FAQ entries - Update landing page with navigation paths and key features - Update setup wizard docs for 6-step preset flow - Update architecture docs with current directory structure - Add full website content for builder.io (12 sections) - Add Apache 2.0 license - Update .gitignore for node_modules and build artifacts Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent bf5cc50 commit e0d70dc

14 files changed

Lines changed: 2123 additions & 22 deletions

File tree

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,8 @@
11
.planning/
2+
node_modules/
3+
.DS_Store
4+
bun.lock
5+
docs-site/bun.lock
6+
docs-site/build/
7+
docs-site/.docusaurus/
8+
docs-site/node_modules/

‎LICENSE‎

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to the Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by the Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding any notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. Please also get an
185+
information on the current year for copyright.
186+
187+
Copyright 2026 opsflow.sh
188+
189+
Licensed under the Apache License, Version 2.0 (the "License");
190+
you may not use this file except in compliance with the License.
191+
You may obtain a copy of the License at
192+
193+
http://www.apache.org/licenses/LICENSE-2.0
194+
195+
Unless required by applicable law or agreed to in writing, software
196+
distributed under the License is distributed on an "AS IS" BASIS,
197+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
198+
See the License for the specific language governing permissions and
199+
limitations under the License.

‎docs-site/README.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
## Installation
6+
7+
```bash
8+
yarn
9+
```
10+
11+
## Local Development
12+
13+
```bash
14+
yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
## Build
20+
21+
```bash
22+
yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
## Deployment
28+
29+
Using SSH:
30+
31+
```bash
32+
USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```bash
38+
GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

‎docs-site/docs/developer-guide/architecture.md‎

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,13 @@ xops.bot layers DevOps capabilities on top of OpenClaw:
2626

2727
- **SOUL.md** -- DevOps personality, security constraints, communication style
2828
- **Branding** -- ASCII art banner, cyan/blue theme, agent identity system
29-
- **Setup wizard** -- interactive onboarding with workspace, channel, tool, safety, and provider selection
29+
- **Setup wizard** -- interactive onboarding with preset, workspace, channel, tool, safety, and provider selection
3030
- **Safety configuration** -- Safe/Standard/Full modes with risk classifications
3131
- **Agent workspaces** -- 5 specialized DevOps agents
3232
- **Profiles** -- Environment-specific settings (dev/stage/prod)
33+
- **Plugins** -- 5 installable skill + tool bundles (kubernetes, docker, aws, terraform, observability)
34+
- **Presets** -- 3 role-based configurations (DevOps Starter, SRE, Platform Engineer)
35+
- **CLI tools** -- plugin management, preset management, runtime safety switching
3336

3437
## Four-File Workspace Pattern
3538

@@ -78,17 +81,36 @@ xopsbot/
7881
dev/profile.json # Development (full mode, all agents)
7982
stage/profile.json # Staging (standard mode, 4 agents)
8083
prod/profile.json # Production (standard mode, 3 agents)
84+
skills/ # Shared skill files (10 skills)
85+
plugins/ # Plugin manifests and registry
86+
manifests/ # Plugin definition files
87+
registry.ts # Plugin registry management
88+
resolve-dependencies.ts # Topological dependency resolution
89+
index.ts # Plugin barrel exports
90+
presets/ # Preset definitions
91+
schema.ts # PresetDefinition Zod schema
92+
definitions/ # Preset definition files
93+
devops.ts # DevOps Starter preset
94+
sre.ts # SRE preset
95+
platform-engineer.ts # Platform Engineer preset
96+
index.ts # Preset barrel exports
97+
cli/ # CLI commands
98+
plugin.ts # Plugin install/remove/list/enable/disable
99+
preset.ts # Preset list/show/apply
100+
safety-switch.ts # Runtime safety mode switching
101+
index.ts # CLI barrel exports
81102
wizard/ # Setup wizard
82103
banner.ts # ASCII art banner (picocolors)
83-
index.ts # Wizard orchestrator (5-step flow)
104+
index.ts # Wizard orchestrator (6-step flow)
84105
types.ts # WizardResults, ProviderChoice types
85106
utils/
86107
first-run.ts # First-run detection (isFirstRun)
87108
steps/
88-
welcome.ts # Welcome note (describes 5 selections)
109+
welcome.ts # Welcome note (describes 6 selections)
110+
preset.ts # Preset selection (DevOps/SRE/Platform/Custom)
89111
workspaces.ts # Workspace selection (multiselect, 5 agents)
90112
channels.ts # Channel selection (multiselect, optional)
91-
tools.ts # DevOps tool selection (multiselect, kubectl default)
113+
tools.ts # DevOps tool selection (multiselect, 8 tools)
92114
safety.ts # Safety mode selection (safe/standard/full)
93115
provider.ts # LLM provider selection with env var detection
94116
generate.ts # Config generation + summary display
@@ -101,15 +123,18 @@ xopsbot/
101123
```
102124
User runs wizard (or auto-launches on first run)
103125
-> Banner displayed
104-
-> Welcome note (describes 5 selections)
105-
-> Select workspaces (multiselect, 5 agents)
126+
-> Welcome note (describes 6 selections)
127+
-> Select role preset (DevOps Starter / SRE / Platform Engineer / Custom)
128+
-> Select workspaces (multiselect, 5 agents -- preset pre-populates defaults)
106129
-> Select channels (multiselect, optional)
107-
-> Select tools (multiselect, kubectl default)
108-
-> Select safety mode (safe/standard/full)
130+
-> Select tools (multiselect, 8 tools -- preset pre-populates defaults)
131+
-> Select safety mode (safe/standard/full -- preset pre-populates default)
109132
-> Select LLM provider (anthropic/openai/google)
133+
-> Install preset plugins (if preset selected)
110134
-> Generate config
111135
-> Copy workspace templates to ~/.xopsbot/workspaces/
112136
-> Generate ~/.openclaw/openclaw.json with channels, tools, provider
137+
-> Write active-preset marker to ~/.xopsbot/active-preset
113138
-> Summary displayed with next steps
114139
-> User runs `openclaw`
115140
-> OpenClaw reads config

0 commit comments

Comments
 (0)