diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b858c9..195c9a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ All notable changes to `ichava/icon-sets-flag` follow [Keep a Changelog](https:/ ### Changed +- **Documentation links point at each repository's own `docs/`** (Sim, 2026-11-03: "all ichava repos have docs in their respective repos. thats by design"). Links to `opensource.simtabi.com/documentation/ichava/...` and the `opensource.simtabi.com/products/ichava/...` homepage, which answer 404 for every ichava page, now go to the matching `docs/*.md` on GitHub, or to the repository itself. Each target was checked to exist on that repository's `main`. The manifest's `homepage` and `support.docs` follow. - **The author and contact address is `ichava@simtabi.com`** (W-11, Sim 2026-11-03), replacing the community address `opensource@simtabi.com` wherever this repository named it. Vulnerability reports still go to `security@simtabi.com`. The test that guards the address expects `ichava@` now. ### Fixed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bba9db1..493d93e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ Contribution guidelines are centralized for the whole Ichava org: - [Code of Conduct](CODE_OF_CONDUCT.md) For this pack specifically: icon assets are refreshed from upstream by the -[icon-sets-sync](https://opensource.simtabi.com/documentation/ichava/icon-sets-sync/maintainer-sync). +[icon-sets-sync](https://github.com/ichava/icon-sets-sync/blob/main/docs/maintainer-sync.md). Please do not hand-edit generated SVGs; contribute fixes to the sync recipe or the upstream source instead. diff --git a/README.md b/README.md index 2d63d46..52e68f0 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ > Country flag icons for the Ichava Laravel icon ecosystem: 542 SVGs, 271 flags in `4x3` and `1x1` ratios, vendored from `lipis/flag-icons`. -Requires [`ichava/core`](https://opensource.simtabi.com/documentation/ichava/core/) `^0.1` on PHP `^8.4.1 || ^8.5` and Laravel `^13`. +Requires [`ichava/core`](https://github.com/ichava/core) `^0.1` on PHP `^8.4.1 || ^8.5` and Laravel `^13`. ## Install @@ -30,7 +30,7 @@ Then require the pack: composer require ichava/icon-sets-flag ``` -The service provider is discovered automatically. Core's [installation guide](https://opensource.simtabi.com/documentation/ichava/core/installation) covers core's own setup. +The service provider is discovered automatically. Core's [installation guide](https://github.com/ichava/core/blob/main/docs/installation.md) covers core's own setup. ## Quick start guide and usage @@ -62,7 +62,7 @@ See [Getting started](docs/getting-started.md) for the full walkthrough, and the ## Documentation -Full documentation is at **[opensource.simtabi.com/documentation/ichava/icon-sets-flag](https://opensource.simtabi.com/documentation/ichava/icon-sets-flag/)**. +The full documentation lives in this repository, under `docs/`, and is indexed below. ### This pack @@ -77,12 +77,12 @@ Full documentation is at **[opensource.simtabi.com/documentation/ichava/icon-set ### Shared across every pack -- [Use an icon pack](https://opensource.simtabi.com/documentation/ichava/core/recipes/use-an-icon-pack) — addressing icons, in Blade and in PHP -- [Seed pack icons](https://opensource.simtabi.com/documentation/ichava/core/recipes/seed-pack-icons) — the seeding pipeline and its options -- [Check pack updates](https://opensource.simtabi.com/documentation/ichava/core/recipes/check-pack-updates) — the update checker and what its statuses mean -- [Serve icons from a CDN](https://opensource.simtabi.com/documentation/ichava/core/recipes/serve-icons-from-a-cdn) — reading this pack's CDN templates out of `config.json` +- [Use an icon pack](https://github.com/ichava/core/blob/main/docs/recipes/use-an-icon-pack.md) — addressing icons, in Blade and in PHP +- [Seed pack icons](https://github.com/ichava/core/blob/main/docs/recipes/seed-pack-icons.md) — the seeding pipeline and its options +- [Check pack updates](https://github.com/ichava/core/blob/main/docs/recipes/check-pack-updates.md) — the update checker and what its statuses mean +- [Serve icons from a CDN](https://github.com/ichava/core/blob/main/docs/recipes/serve-icons-from-a-cdn.md) — reading this pack's CDN templates out of `config.json` -Its upstream is `lipis/flag-icons`; run core's [check pack updates](https://opensource.simtabi.com/documentation/ichava/core/recipes/check-pack-updates) recipe to see whether a newer release exists. +Its upstream is `lipis/flag-icons`; run core's [check pack updates](https://github.com/ichava/core/blob/main/docs/recipes/check-pack-updates.md) recipe to see whether a newer release exists. ## Contributing & security diff --git a/composer.json b/composer.json index e40f5c0..55cd9bb 100644 --- a/composer.json +++ b/composer.json @@ -10,7 +10,7 @@ "svg", "ichava" ], - "homepage": "https://opensource.simtabi.com/products/ichava/icon-sets-flag", + "homepage": "https://github.com/ichava/icon-sets-flag", "license": "MIT", "authors": [ { @@ -95,6 +95,6 @@ "source": "https://github.com/ichava/icon-sets-flag", "issues": "https://github.com/ichava/icon-sets-flag/issues", "security": "https://github.com/ichava/icon-sets-flag/security/policy", - "docs": "https://opensource.simtabi.com/documentation/ichava/icon-sets-flag/" + "docs": "https://github.com/ichava/icon-sets-flag/tree/main/docs" } } diff --git a/docs/architecture.md b/docs/architecture.md index c20835d..669851b 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -33,12 +33,12 @@ is the rule; a transitive dependency is not a contract. Its upstream is `flag-icons`, and the version these SVGs came from is recorded in `resources/assets/svg/config.json` under `upstream.current_version` rather than written out -here, so the two cannot drift. Core's [check pack updates](https://opensource.simtabi.com/documentation/ichava/core/recipes/check-pack-updates) +here, so the two cannot drift. Core's [check pack updates](https://github.com/ichava/core/blob/main/docs/recipes/check-pack-updates.md) recipe reports whether a newer release exists. ## See also -- [Core architecture](https://opensource.simtabi.com/documentation/ichava/core/architecture) -- topology, boot order, the registry +- [Core architecture](https://github.com/ichava/core/blob/main/docs/architecture.md) -- topology, boot order, the registry - [Attribution](attribution.md) -- the upstream project and its licence - [Release](release.md) diff --git a/docs/configuration.md b/docs/configuration.md index 6d200b5..6c441f2 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -26,7 +26,7 @@ categories; the copies this file used to carry were read by nothing and are gone Cache, queue, database, logging, security and the `ICHAVA_*` environment surface are **core's**, and apply to every pack at once. They are documented in core's -[configuration guide](https://opensource.simtabi.com/documentation/ichava/core/configuration) and [environment variables](https://opensource.simtabi.com/documentation/ichava/core/environment). +[configuration guide](https://github.com/ichava/core/blob/main/docs/configuration.md) and [environment variables](https://github.com/ichava/core/blob/main/docs/environment.md). A value set here cannot change how core seeds, caches or sanitises; that is the point of the split. diff --git a/docs/getting-started.md b/docs/getting-started.md index 5d0911c..bd55d91 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -18,7 +18,7 @@ The component is core's and is generic: the pack is named in the path, not in th ``` Both spellings of the path resolve to the same icon -- slash and dot are normalised by one -resolver, documented in core's [icon path format](https://opensource.simtabi.com/documentation/ichava/core/tools/icon-path-format). +resolver, documented in core's [icon path format](https://github.com/ichava/core/blob/main/docs/tools/icon-path-format.md). ## If nothing renders @@ -29,13 +29,13 @@ php artisan ichava::ichava-core.info icons --package=ichava/icon-sets-flag ``` Zero rows means [Installation](installation.md) step 4 is outstanding. Core's -[troubleshooting](https://opensource.simtabi.com/documentation/ichava/core/troubleshooting) covers the rest. +[troubleshooting](https://github.com/ichava/core/blob/main/docs/troubleshooting.md) covers the rest. ## See also - [Variants](variants.md) -- what this pack ships and how to address it - [Customisation](customization.md) -- colour, size, and this pack's own knobs -- [Use an icon pack](https://opensource.simtabi.com/documentation/ichava/core/recipes/use-an-icon-pack) -- the generic guide, for any pack +- [Use an icon pack](https://github.com/ichava/core/blob/main/docs/recipes/use-an-icon-pack.md) -- the generic guide, for any pack --- diff --git a/docs/installation.md b/docs/installation.md index e2e946a..366da47 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -4,7 +4,7 @@ Three steps: point Composer at the repositories, require the pack, seed it. ## Requirements -PHP `^8.4.1 || ^8.5`, Laravel `^13`, and [`ichava/core`](https://opensource.simtabi.com/documentation/ichava/core/) `^0.1` on the same application. +PHP `^8.4.1 || ^8.5`, Laravel `^13`, and [`ichava/core`](https://github.com/ichava/core) `^0.1` on the same application. Core is the engine; this pack is only icons and the provider that registers them. ## The repositories block @@ -12,7 +12,7 @@ Core is the engine; this pack is only icons and the provider that registers them The `ichava/*` packages are on Packagist, but the `laranail/*` packages core depends on are not yet, so Composer has to be told where to find them. Composer reads `repositories` only from the root package, which is why the block belongs in the **application's** `composer.json` and has to name the whole transitive closure rather than just this -pack. Core's [installation guide](https://opensource.simtabi.com/documentation/ichava/core/installation) gives the full block. +pack. Core's [installation guide](https://github.com/ichava/core/blob/main/docs/installation.md) gives the full block. ## Require it @@ -30,7 +30,7 @@ php artisan ichava::ichava-core.database seed --package=ichava/icon-sets-flag **This step is not optional.** Until it runs the registry holds no rows for this pack and every lookup returns nothing, which is the most common "it does not work" in the ecosystem. See -[seed pack icons](https://opensource.simtabi.com/documentation/ichava/core/recipes/seed-pack-icons). +[seed pack icons](https://github.com/ichava/core/blob/main/docs/recipes/seed-pack-icons.md). ## Publish the config, only if you need it diff --git a/docs/release.md b/docs/release.md index 857ea70..475b8b5 100644 --- a/docs/release.md +++ b/docs/release.md @@ -60,12 +60,12 @@ An empty result means no consumed code moved. ## Refreshing the icons is not a release New icons arrive by an upstream sync, not by cutting a tag here. -[`ichava/icon-sets-sync`](https://opensource.simtabi.com/documentation/ichava/icon-sets-sync/upstream-tracking) +[`ichava/icon-sets-sync`](https://github.com/ichava/icon-sets-sync/blob/main/docs/upstream-tracking.md) polls `flag-icons`, refreshes the vendored SVGs, bumps `upstream.current_version` in `resources/assets/svg/config.json` and opens a pull request. That pull request is the change; a release follows it only if you want the new icons published under a tag. -Core's [check pack updates](https://opensource.simtabi.com/documentation/ichava/core/recipes/check-pack-updates) reports whether a newer upstream +Core's [check pack updates](https://github.com/ichava/core/blob/main/docs/recipes/check-pack-updates.md) reports whether a newer upstream release exists. **The vendored version lives in `config.json` and nowhere else** -- writing it into prose as well is how a README came to advertise a release the pack did not ship.