From 71b968d0e383d9453b5a58393ae6c2c13993675c Mon Sep 17 00:00:00 2001 From: Joshua Gilman Date: Mon, 4 May 2026 13:14:40 -0700 Subject: [PATCH] docs: clean up imgcli scaffold --- .github/repository-settings.toml | 14 +-- .gitignore | 2 +- .moon/toolchains.yml | 42 +------ .moon/workspace.yml | 4 +- CONTRIBUTING.md | 42 +++---- LICENSE | 10 ++ LICENSE-APACHE | 185 +++++++++++++++++++++++++++++++ LICENSE-MIT | 21 ++++ README.md | 65 ++++++----- SECURITY.md | 31 +----- DESIGN.md => docs/docs/design.md | 5 + docs/docs/index.md | 23 ++-- docs/docusaurus.config.ts | 20 ++-- docs/moon.yml | 40 +++---- docs/package-lock.json | 4 +- docs/package.json | 2 +- moon.yml | 12 +- 17 files changed, 345 insertions(+), 177 deletions(-) create mode 100644 LICENSE create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT rename DESIGN.md => docs/docs/design.md (99%) diff --git a/.github/repository-settings.toml b/.github/repository-settings.toml index f27b76b..6624f73 100644 --- a/.github/repository-settings.toml +++ b/.github/repository-settings.toml @@ -1,15 +1,13 @@ # GitHub repository settings managed by scripts/configure_github_repo.py. # # Run: -# uv run scripts/configure_github_repo.py plan --repo OWNER/REPO -# uv run scripts/configure_github_repo.py apply --repo OWNER/REPO +# uv run scripts/configure_github_repo.py plan --repo meigma/imgcli +# uv run scripts/configure_github_repo.py apply --repo meigma/imgcli # # Notes: # - Supported settings are applied directly through the GitHub REST API. # - Unsupported settings stay in this file so the script can report manual follow-ups. # - The branch ruleset follows the repository default branch via ~DEFAULT_BRANCH. -# - Status checks are enabled in the screenshots, but the actual contexts are repository-specific. -# Fill them in before expecting the status-check rules to be applied. [repository] default_branch = "master" @@ -72,7 +70,7 @@ enabled = true strict_required_status_checks_policy = false do_not_enforce_on_create = false contexts = [ - # "ci / build", + "ci", ] [rulesets.tags_default] @@ -92,12 +90,10 @@ bypass = [ ] [rulesets.tags_default.status_checks] -enabled = true +enabled = false strict_required_status_checks_policy = false do_not_enforce_on_create = false -contexts = [ - # "release / verify", -] +contexts = [] [unsupported] # GitHub Archive Program diff --git a/.gitignore b/.gitignore index eea33ad..6cd1491 100644 --- a/.gitignore +++ b/.gitignore @@ -67,7 +67,7 @@ pnpm-debug.log* .svelte-kit/ coverage/ -# Template repo outputs +# Documentation outputs docs/node_modules/ docs/build/ docs/.docusaurus/ diff --git a/.moon/toolchains.yml b/.moon/toolchains.yml index d4a7ee7..726c0b4 100644 --- a/.moon/toolchains.yml +++ b/.moon/toolchains.yml @@ -1,10 +1,9 @@ -# Active toolchains for the current template. -# The docs project uses npm today, but this file is meant to be a starting -# point for future repos that may choose different ecosystems. +# Active toolchains for imgcli. +# The current repository content is the npm-backed documentation site. javascript: packageManager: 'npm' - inferTasksFromScripts: true + inferTasksFromScripts: false npm: {} @@ -12,37 +11,4 @@ node: version: '22.22.2' syncVersionManagerConfig: 'nvm' -# Configure npm directly when you want to pin the CLI or customize installs. -# npm: -# version: 'REPLACE_ME_NPM_VERSION' -# installArgs: ['--include=dev'] - -# Swap npm for pnpm, yarn, bun, or deno as needed. -# javascript: -# packageManager: 'pnpm' -# inferTasksFromScripts: true -# -# pnpm: -# version: 'REPLACE_ME_PNPM_VERSION' -# -# bun: -# version: 'REPLACE_ME_BUN_VERSION' -# -# deno: -# version: 'REPLACE_ME_DENO_VERSION' - -# Stable non-JavaScript toolchains in Moon v2. -# go: -# version: 'REPLACE_ME_GO_VERSION' -# -# rust: -# version: 'REPLACE_ME_RUST_VERSION' -# components: ['clippy', 'rustfmt'] - -# Python remains unstable in Moon v2. -# unstable_python: -# version: 'REPLACE_ME_PYTHON_VERSION' -# packageManager: 'uv' -# -# unstable_uv: -# version: 'REPLACE_ME_UV_VERSION' +# Add the Go toolchain when the CLI implementation lands. diff --git a/.moon/workspace.yml b/.moon/workspace.yml index e83c3e9..37624e9 100644 --- a/.moon/workspace.yml +++ b/.moon/workspace.yml @@ -1,4 +1,4 @@ -# Shared Moon workspace configuration for the repository template. +# Shared Moon workspace configuration for imgcli. # Keep the current projects explicit, then uncomment the discovery patterns # below as the template grows into apps, packages, services, or tools. @@ -24,7 +24,7 @@ projects: defaultProject: 'docs' vcs: - defaultBranch: 'main' + defaultBranch: 'master' provider: 'github' # Uncomment when you want Moon to aggregate project owners into CODEOWNERS. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6cfa37..cf2718f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,18 @@ # Contributing -> Template note: replace every `ALL_CAPS` placeholder in this file before publishing or sharing the repository. - -Thank you for your interest in contributing to `PROJECT_NAME`. -This guide covers questions, bug reports, feature requests, and pull requests. +Thank you for your interest in contributing to `imgcli`. This guide covers +questions, bug reports, feature requests, and pull requests. For private vulnerability reporting, use [SECURITY.md](SECURITY.md) instead of public channels. ## Asking Questions -Use `REPLACE_ME_SUPPORT_CHANNEL` for usage questions, troubleshooting, and general discussion. -If the project uses multiple support channels, document which kinds of questions belong in each one. +Use [GitHub Discussions](https://github.com/meigma/imgcli/discussions) for usage +questions, troubleshooting, and general discussion. ## Reporting Bugs -Report non-security bugs through `REPLACE_ME_BUG_REPORT_CHANNEL`. +Report non-security bugs through +[GitHub Issues](https://github.com/meigma/imgcli/issues). Include the following details when possible: - version, commit, or environment details @@ -26,8 +25,11 @@ If you are reporting a security issue, stop and follow [SECURITY.md](SECURITY.md ## Proposing Features -Use `REPLACE_ME_FEATURE_REQUEST_CHANNEL` for feature requests and design proposals. -For larger changes, describe the problem, the proposed approach, and any compatibility or migration concerns before starting implementation. +Use [GitHub Issues](https://github.com/meigma/imgcli/issues) or +[GitHub Discussions](https://github.com/meigma/imgcli/discussions) for feature +requests and design proposals. For larger changes, describe the problem, the +proposed approach, and any compatibility or migration concerns before starting +implementation. ## Pull Requests @@ -39,30 +41,22 @@ Unless the repository documents a different process, contributors should: 4. Describe the change clearly in the pull request. 5. Make sure CI passes before requesting review. -Replace this section with any repository-specific expectations such as branch naming, commit conventions, changelog entries, or release notes requirements. - ## Local Setup -Replace this section with the actual setup steps for the repository. - ```sh -REPLACE_ME_SETUP_COMMAND +npm ci --prefix docs ``` Useful project commands: ```sh -REPLACE_ME_TEST_COMMAND -REPLACE_ME_LINT_COMMAND -REPLACE_ME_FORMAT_COMMAND +npm --prefix docs run typecheck +npm --prefix docs run build +moon ci --summary minimal ``` -## Code of Conduct - -Replace this section with the actual Code of Conduct path or URL. -Example: `REPLACE_ME_CODE_OF_CONDUCT_PATH_OR_URL` - ## License and Ownership -State any contribution licensing terms only if the project actually requires them. -If the repository uses a CLA, DCO, or other contribution agreement, replace this section with the real policy. +Unless otherwise stated, contributions are accepted under the same dual license +as the repository: Apache License 2.0 or MIT, at your option. This repository +does not currently require a CLA or DCO sign-off. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a79a630 --- /dev/null +++ b/LICENSE @@ -0,0 +1,10 @@ +imgcli is licensed under either of: + +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE)) +- MIT License ([LICENSE-MIT](LICENSE-MIT)) + +at your option. + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in imgcli by you, as defined in the Apache License, Version 2.0, +shall be dual licensed as above, without any additional terms or conditions. diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..35cdcdc --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,185 @@ +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, and +distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by the +copyright owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all other +entities that control, are controlled by, or are under common control with +that entity. For the purposes of this definition, "control" means (i) the +power, direct or indirect, to cause the direction or management of such +entity, whether by contract or otherwise, or (ii) ownership of fifty percent +(50%) or more of the outstanding shares, or (iii) beneficial ownership of such +entity. + +"You" (or "Your") shall mean an individual or Legal Entity exercising +permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, +including but not limited to software source code, documentation source, and +configuration files. + +"Object" form shall mean any form resulting from mechanical transformation or +translation of a Source form, including but not limited to compiled object +code, generated documentation, and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or Object form, +made available under the License, as indicated by a copyright notice that is +included in or attached to the work (an example is provided in the Appendix +below). + +"Derivative Works" shall mean any work, whether in Source or Object form, that +is based on (or derived from) the Work and for which the editorial revisions, +annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. For the purposes of this License, Derivative +Works shall not include works that remain separable from, or merely link (or +bind by name) to the interfaces of, the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including the original +version of the Work and any modifications or additions to that Work or +Derivative Works thereof, that is intentionally submitted to Licensor for +inclusion in the Work by the copyright owner or by an individual or Legal +Entity authorized to submit on behalf of the copyright owner. For the purposes +of this definition, "submitted" means any form of electronic, verbal, or +written communication sent to the Licensor or its representatives, including +but not limited to communication on electronic mailing lists, source code +control systems, and issue tracking systems that are managed by, or on behalf +of, the Licensor for the purpose of discussing and improving the Work, but +excluding communication that is conspicuously marked or otherwise designated +in writing by the copyright owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity on behalf +of whom a Contribution has been received by Licensor and subsequently +incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of this +License, each Contributor hereby grants to You a perpetual, worldwide, +non-exclusive, no-charge, royalty-free, irrevocable copyright license to +reproduce, prepare Derivative Works of, publicly display, publicly perform, +sublicense, and distribute the Work and such Derivative Works in Source or +Object form. + +3. Grant of Patent License. Subject to the terms and conditions of this +License, each Contributor hereby grants to You a perpetual, worldwide, +non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this +section) patent license to make, have made, use, offer to sell, sell, import, +and otherwise transfer the Work, where such license applies only to those +patent claims licensable by such Contributor that are necessarily infringed by +their Contribution(s) alone or by combination of their Contribution(s) with the +Work to which such Contribution(s) was submitted. If You institute patent +litigation against any entity (including a cross-claim or counterclaim in a +lawsuit) alleging that the Work or a Contribution incorporated within the Work +constitutes direct or contributory patent infringement, then any patent +licenses granted to You under this License for that Work shall terminate as of +the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the Work or +Derivative Works thereof in any medium, with or without modifications, and in +Source or Object form, provided that You meet the following conditions: + +(a) You must give any other recipients of the Work or Derivative Works a copy +of this License; and + +(b) You must cause any modified files to carry prominent notices stating that +You changed the files; and + +(c) You must retain, in the Source form of any Derivative Works that You +distribute, all copyright, patent, trademark, and attribution notices from the +Source form of the Work, excluding those notices that do not pertain to any +part of the Derivative Works; and + +(d) If the Work includes a "NOTICE" text file as part of its distribution, then +any Derivative Works that You distribute must include a readable copy of the +attribution notices contained within such NOTICE file, excluding those notices +that do not pertain to any part of the Derivative Works, in at least one of +the following places: within a NOTICE text file distributed as part of the +Derivative Works; within the Source form or documentation, if provided along +with the Derivative Works; or, within a display generated by the Derivative +Works, if and wherever such third-party notices normally appear. The contents +of the NOTICE file are for informational purposes only and do not modify the +License. You may add Your own attribution notices within Derivative Works that +You distribute, alongside or as an addendum to the NOTICE text from the Work, +provided that such additional attribution notices cannot be construed as +modifying the License. + +You may add Your own copyright statement to Your modifications and may provide +additional or different license terms and conditions for use, reproduction, or +distribution of Your modifications, or for any such Derivative Works as a +whole, provided Your use, reproduction, and distribution of the Work otherwise +complies with the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, any +Contribution intentionally submitted for inclusion in the Work by You to the +Licensor shall be under the terms and conditions of this License, without any +additional terms or conditions. Notwithstanding the above, nothing herein shall +supersede or modify the terms of any separate license agreement you may have +executed with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade names, +trademarks, service marks, or product names of the Licensor, except as required +for reasonable and customary use in describing the origin of the Work and +reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or agreed to in +writing, Licensor provides the Work (and each Contributor provides its +Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied, including, without limitation, any warranties +or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A +PARTICULAR PURPOSE. You are solely responsible for determining the +appropriateness of using or redistributing the Work and assume any risks +associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, whether in +tort (including negligence), contract, or otherwise, unless required by +applicable law (such as deliberate and grossly negligent acts) or agreed to in +writing, shall any Contributor be liable to You for damages, including any +direct, indirect, special, incidental, or consequential damages of any +character arising as a result of this License or out of the use or inability to +use the Work (including but not limited to damages for loss of goodwill, work +stoppage, computer failure or malfunction, or any and all other commercial +damages or losses), even if such Contributor has been advised of the +possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing the Work or +Derivative Works thereof, You may choose to offer, and charge a fee for, +acceptance of support, warranty, indemnity, or other liability obligations +and/or rights consistent with this License. However, in accepting such +obligations, You may act only on Your own behalf and on Your sole +responsibility, not on behalf of any other Contributor, and only if You agree +to indemnify, defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason of your +accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + +To apply the Apache License to your work, attach the following boilerplate +notice, with the fields enclosed by brackets "[]" replaced with your own +identifying information. (Don't include the brackets!) The text should be +enclosed in the appropriate comment syntax for the file format. We also +recommend that a file or class name and description of purpose be included on +the same "printed page" as the copyright notice for easier identification +within third-party archives. + +Copyright 2026 Meigma + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..6dbc1f6 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Meigma + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 5e13679..e03f0c3 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,68 @@ -# PROJECT_NAME +# imgcli -> Template note: replace every `ALL_CAPS` placeholder in this file before publishing or sharing the repository. +`imgcli` is a prototype CLI for building disk image artifacts from Git-tracked +CUE configuration and, later, publishing those artifacts to `imgsrv`. -`PROJECT_NAME` is `PROJECT_SUMMARY`. -It is intended for `PRIMARY_USE_CASE` and is maintained by `AUTHOR_NAME` or `ORGANIZATION_NAME`. +The repository is still in the design and scaffolding stage. The current working +design is intentionally lightweight and lives in [docs/docs/design.md](docs/docs/design.md). ## Quick Start -Replace this section with the shortest working path for a new user. +There is not an installable `imgcli` binary yet. The working repository content +today is the documentation site and project scaffolding. ### Prerequisites -- `REPLACE_ME_RUNTIME_OR_LANGUAGE` -- `REPLACE_ME_REQUIRED_TOOLING` -- `REPLACE_ME_EXTERNAL_DEPENDENCIES` +- Node.js `22.22.2` +- npm +- Moon, if you want to run the same task graph used by CI -### Install +### Build the docs ```sh -REPLACE_ME_INSTALL_COMMAND +npm ci --prefix docs +npm --prefix docs run build ``` -### Run +### Run the docs locally ```sh -REPLACE_ME_START_COMMAND +npm --prefix docs run start ``` ## Usage -Replace this section with the most common workflow for the repository. +The intended CLI workflow is Git-as-truth image publishing: ```sh -REPLACE_ME_PRIMARY_COMMAND_OR_ENTRYPOINT +imgcli publish --version 1.0.0 --alias latest --alias prod config.cue ``` -Expected result: - -- `REPLACE_ME_EXPECTED_OUTPUT_OR_BEHAVIOR` +That command is design intent, not current behavior. The v0 prototype will start +with local-only `plan` and `build` paths for one IncusOS artifact, then add +publishing once the `imgsrv` API is stable enough to target. ## Configuration -Document the minimum configuration needed to use the project. +`imgcli` will read one CUE image configuration file, resolve it into concrete +artifact work, and write deterministic local outputs under `dist/` by default. -- `REPLACE_ME_ENV_VAR_NAME`: `REPLACE_ME_ENV_VAR_DESCRIPTION` -- `REPLACE_ME_CONFIG_FILE`: `REPLACE_ME_CONFIG_FILE_PURPOSE` +Release versions and aliases are publish-time inputs. They should come from the +release pipeline, usually a Git tag plus explicit CLI flags, rather than being +hard-coded into the CUE file. ## Documentation -- Main docs: `REPLACE_ME_DOCS_URL_OR_PATH` -- Examples: `REPLACE_ME_EXAMPLES_URL_OR_PATH` -- Architecture notes: `REPLACE_ME_ARCHITECTURE_DOC_URL_OR_PATH` +- Documentation site source: [docs/docs](docs/docs) +- Working design: [docs/docs/design.md](docs/docs/design.md) ## Support -Use `REPLACE_ME_SUPPORT_CHANNEL` for questions and general support. -Use `REPLACE_ME_BUG_REPORT_CHANNEL` for non-security bug reports. +Use [GitHub Discussions](https://github.com/meigma/imgcli/discussions) for +questions and general support. Use +[GitHub Issues](https://github.com/meigma/imgcli/issues) for non-security bug +reports. + Do not report vulnerabilities in public channels. See [SECURITY.md](SECURITY.md). ## Contributing @@ -68,8 +75,6 @@ See [SECURITY.md](SECURITY.md) for supported versions and the private vulnerabil ## License -Replace this section with the actual license name and add the corresponding `LICENSE` file to the repository. - -Example: - -`PROJECT_NAME` is licensed under the `REPLACE_ME_LICENSE_NAME`. +`imgcli` is dual-licensed under the Apache License 2.0 or the MIT License, at +your option. See [LICENSE](LICENSE), [LICENSE-APACHE](LICENSE-APACHE), and +[LICENSE-MIT](LICENSE-MIT). diff --git a/SECURITY.md b/SECURITY.md index 264f987..dbae64b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,27 +1,17 @@ # Security Policy -> Template note: replace every `ALL_CAPS` placeholder in this file before publishing or sharing the repository. - -This document explains which versions of `PROJECT_NAME` receive security updates and how to report vulnerabilities privately. +This document explains which versions of `imgcli` receive security updates and +how to report vulnerabilities privately. ## Supported Versions -Replace this table with the actual support policy for the repository. -Do not claim support windows or release lines that the project does not actually maintain. - -| Version | Supported | -| ------- | --------- | -| `REPLACE_ME_SUPPORTED_VERSION_1` | Yes | -| `REPLACE_ME_SUPPORTED_VERSION_2` | `REPLACE_ME_YES_OR_NO` | -| `REPLACE_ME_UNSUPPORTED_VERSION` | No | - -If a table is not the right fit, replace it with a short policy statement such as: - -`REPLACE_ME_SUPPORTED_VERSION_POLICY` +`imgcli` has not published a supported release yet. Until the first release, use +the default branch as the only supported development line. ## Reporting a Vulnerability -Report vulnerabilities privately through `REPLACE_ME_PRIVATE_REPORTING_CHANNEL`. +Report vulnerabilities privately through +[GitHub private vulnerability reporting](https://github.com/meigma/imgcli/security/advisories/new). Do not use public GitHub issues, pull requests, discussions, chat channels, or other public forums for vulnerability reports. @@ -32,12 +22,3 @@ When reporting a vulnerability, include as much of the following as possible: - steps to reproduce or a minimal proof of concept - any relevant logs, screenshots, or traces - any suggested mitigations or fixes, if available - -## Disclosure Process - -Replace this section only if the project has a documented disclosure process. -If not, remove this section rather than inventing timelines or response guarantees. - -- Acknowledgement target: `REPLACE_ME_ACKNOWLEDGEMENT_POLICY` -- Fix or remediation target: `REPLACE_ME_REMEDIATION_POLICY` -- Advisory publication location: `REPLACE_ME_ADVISORY_LOCATION` diff --git a/DESIGN.md b/docs/docs/design.md similarity index 99% rename from DESIGN.md rename to docs/docs/design.md index 75a07db..7fab206 100644 --- a/DESIGN.md +++ b/docs/docs/design.md @@ -1,3 +1,8 @@ +--- +title: Initial Design +description: Temporary working design for the imgcli prototype. +--- + # imgcli Initial Design `imgcli` is a CLI for building disk image artifacts from Git-tracked diff --git a/docs/docs/index.md b/docs/docs/index.md index 5b6f64a..d1a4a3b 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,16 +1,21 @@ --- -title: PROJECT_NAME Docs +title: imgcli Docs slug: / -description: Starting point for PROJECT_NAME documentation. +description: Documentation for imgcli. --- -# PROJECT_NAME Docs +# imgcli Docs -This site is the starting point for `PROJECT_NAME` documentation. +`imgcli` is a prototype CLI for building disk image artifacts from Git-tracked +CUE configuration and, later, publishing those artifacts to `imgsrv`. -Replace this page with: +The project is intentionally early. Start with the +[initial design](./design.md), which captures the current product boundary, +prototype scope, configuration direction, and planned command set. -- `PROJECT_SUMMARY` -- `QUICKSTART_STEPS` -- `GUIDES_AND_REFERENCE_LINKS` -- `SUPPORT_AND_CONTACT_PATHS` +## Current Status + +- No installable CLI binary has been published yet. +- The first prototype target is a local-only IncusOS artifact path. +- Publishing will target `imgsrv` once its API is stable enough to drive + against. diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index c60270e..60b93e5 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -3,15 +3,15 @@ import type {Config} from '@docusaurus/types'; import type * as Preset from '@docusaurus/preset-classic'; const config: Config = { - title: 'PROJECT_NAME', - tagline: 'Starting point for PROJECT_NAME documentation', + title: 'imgcli', + tagline: 'Build disk image artifacts from Git-tracked configuration', future: { v4: true, }, - url: 'https://docs.example.com', - baseUrl: '/', - organizationName: 'REPLACE_ME_ORG', - projectName: 'REPLACE_ME_REPO', + url: 'https://meigma.github.io', + baseUrl: '/imgcli/', + organizationName: 'meigma', + projectName: 'imgcli', onBrokenLinks: 'throw', markdown: { hooks: { @@ -31,7 +31,7 @@ const config: Config = { routeBasePath: '/', sidebarPath: false, breadcrumbs: false, - editUrl: 'https://github.com/REPLACE_ME_ORG/REPLACE_ME_REPO/edit/main/docs/', + editUrl: 'https://github.com/meigma/imgcli/edit/master/docs/', }, blog: false, theme: { @@ -46,10 +46,10 @@ const config: Config = { respectPrefersColorScheme: true, }, navbar: { - title: 'PROJECT_NAME', + title: 'imgcli', items: [ { - href: 'https://github.com/REPLACE_ME_ORG/REPLACE_ME_REPO', + href: 'https://github.com/meigma/imgcli', label: 'GitHub', position: 'right', className: 'navbar__item--github', @@ -58,7 +58,7 @@ const config: Config = { }, footer: { style: 'dark', - copyright: `Copyright © ${new Date().getFullYear()} REPLACE_ME_ORG. Built with Docusaurus.`, + copyright: `Copyright © ${new Date().getFullYear()} Meigma. Built with Docusaurus.`, }, prism: { theme: prismThemes.github, diff --git a/docs/moon.yml b/docs/moon.yml index ab03d9b..e17d4ef 100644 --- a/docs/moon.yml +++ b/docs/moon.yml @@ -6,11 +6,11 @@ tags: - 'docusaurus' project: - title: 'PROJECT_NAME docs' - description: 'Docusaurus documentation site for PROJECT_NAME.' - owner: 'REPLACE_ME_OWNER' + title: 'imgcli docs' + description: 'Docusaurus documentation site for imgcli.' + owner: 'meigma' maintainers: - - 'REPLACE_ME_MAINTAINER' + - 'meigma' toolchains: default: 'node' @@ -26,19 +26,19 @@ fileGroups: - 'src/**/*' - 'static/**/*' -# Moon will infer tasks like build, start, serve, and typecheck from -# package.json scripts because javascript.inferTasksFromScripts is enabled -# in /.moon/toolchains.yml. -# -# Add explicit tasks here when you need custom inputs, outputs, or -# cross-project dependencies. -# -# tasks: -# build-static: -# command: 'npm run build' -# toolchains: ['javascript', 'node', 'npm'] -# inputs: -# - '@group(configs)' -# - '@group(sources)' -# outputs: -# - 'build/**/*' +tasks: + build: + command: 'npm run build' + toolchains: ['javascript', 'node', 'npm'] + inputs: + - '@group(configs)' + - '@group(sources)' + outputs: + - 'build/**/*' + + typecheck: + command: 'npm run typecheck' + toolchains: ['javascript', 'node', 'npm'] + inputs: + - '@group(configs)' + - '@group(sources)' diff --git a/docs/package-lock.json b/docs/package-lock.json index f25ca73..98445f8 100644 --- a/docs/package-lock.json +++ b/docs/package-lock.json @@ -1,11 +1,11 @@ { - "name": "docs", + "name": "imgcli-docs", "version": "0.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "docs", + "name": "imgcli-docs", "version": "0.0.0", "dependencies": { "@docusaurus/core": "^3.10.0", diff --git a/docs/package.json b/docs/package.json index 9186a6b..67a7826 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,5 +1,5 @@ { - "name": "docs", + "name": "imgcli-docs", "version": "0.0.0", "private": true, "scripts": { diff --git a/moon.yml b/moon.yml index abc93c5..43b6c1c 100644 --- a/moon.yml +++ b/moon.yml @@ -1,17 +1,17 @@ -layer: 'scaffolding' +layer: 'application' project: - title: 'Repository template' - description: 'Workspace-level configuration, shared automation, and template defaults.' - owner: 'REPLACE_ME_OWNER' + title: 'imgcli' + description: 'CLI for building disk image artifacts from Git-tracked configuration.' + owner: 'meigma' maintainers: - - 'REPLACE_ME_MAINTAINER' + - 'meigma' workspace: inheritedTasks: include: [] -# Add repository-wide maintenance tasks here as the template grows. +# Add repository-wide maintenance tasks here as imgcli grows. # Examples: # # tasks: