docs: documentation overhaul

- Standardize README.md with consistent badges and structure
- Add CONTRIBUTING.md with repo-specific dev setup
- Add/update Antora docs structure
- Remove per-repo GitHub Pages workflow
- Point documentation badge to central site

Signed-off-by: jimisola <jimisola@jimisola.com>

Author: Jimisola Laursen

.github/workflows/publish_gh_pages.yml

@@ -0,0 +1,25 @@
+# Contributing to reqstool-python-hatch-plugin
+
+Thank you for your interest in contributing!
+
+For DCO sign-off, commit conventions, and code review process, see the organization-wide [CONTRIBUTING.md](https://github.com/reqstool/.github/blob/main/CONTRIBUTING.md).
+
+## Prerequisites
+
+- Python 3.13+
+- [Hatch](https://hatch.pypa.io/) (`pip install hatch`)
+
+## Setup
+
+```bash
+git clone https://github.com/reqstool/reqstool-python-hatch-plugin.git
+cd reqstool-python-hatch-plugin
+hatch env create
+```
+
+## Build & Test
+
+```bash
+hatch build
+hatch run test
+```

CONTRIBUTING.md

@@ -1,36 +1,28 @@
-
 [![Commit Activity](https://img.shields.io/github/commit-activity/m/reqstool/reqstool-python-hatch-plugin?label=commits&style=for-the-badge)](https://github.com/reqstool/reqstool-python-hatch-plugin/pulse)
 [![GitHub Issues](https://img.shields.io/github/issues/reqstool/reqstool-python-hatch-plugin?style=for-the-badge&logo=github)](https://github.com/reqstool/reqstool-python-hatch-plugin/issues)
 [![License](https://img.shields.io/github/license/reqstool/reqstool-python-hatch-plugin?style=for-the-badge&logo=opensourceinitiative)](https://opensource.org/license/mit/)
 [![Build](https://img.shields.io/github/actions/workflow/status/reqstool/reqstool-python-hatch-plugin/build.yml?style=for-the-badge&logo=github)](https://github.com/reqstool/reqstool-python-hatch-plugin/actions/workflows/build.yml)
-[![Static Badge](https://img.shields.io/badge/Documentation-blue?style=for-the-badge&link=docs)](https://reqstool.github.io/reqstool-python-hatch-plugin/reqstool-python-hatch-plugin/0.0.2/index.html)
-
-
+[![Documentation](https://img.shields.io/badge/Documentation-blue?style=for-the-badge&link=docs)](https://reqstool.github.io)
 
-## Description
+# Reqstool Python Hatch Plugin
 
-This documentation provides information on how to use the Reqstool Hatch Plugin. The plugin is designed to be used with the Hatch build tool and facilitates the integration of the Reqstool Decorators in your project.
+Hatch build hook plugin for [reqstool](https://github.com/reqstool/reqstool-client) that collects decorated code and generates `annotations.yml` during `hatch build`.
 
 ## Installation
 
-To use the Reqstool Hatch Plugin, follow these steps:
-
-- Update your project dependencies in the `pyproject.toml` file and 
-ensure that the Reqstool Decorators' dependency is listed as follows;
+Add to your `pyproject.toml`:
 
 ```toml
-dependencies = ["reqstool-python-decorators==<version>"]
+[build-system]
+requires = [
+  "hatchling",
+  "reqstool-python-hatch-plugin==<version>",
+]
 ```
 
-When you declare this in the pyproject.toml file, you are specifying the required versions for the dependency of the Reqstool Decorators. This ensures that the correct version of the dependencies are used when installing and running your project.
-
-
-
 ## Usage
 
-### Configuration
-
-The plugin can be configured through the `pyproject.toml` file. Configure plugin in `pyproject.toml`as follows;
+Configure the plugin in `pyproject.toml`:
 
 ```toml
 [tool.hatch.build.hooks.reqstool]
@@ -40,17 +32,16 @@ dataset_directory = "docs/reqstool"
 output_directory = "build/reqstool"
 ```
 
-And under `requires` in `[build-system]` you need to add the plugin with the version, see example;
+The plugin uses [reqstool-python-decorators](https://github.com/reqstool/reqstool-python-decorators) for processing.
 
-```toml
-[build-system]
-requires = [
-  "hatchling",
-  "reqstool-python-hatch-plugin==<version>",
-]
-```
+## Documentation
+
+Full documentation can be found [here](https://reqstool.github.io).
+
+## Contributing
 
+See the organization-wide [CONTRIBUTING.md](https://github.com/reqstool/.github/blob/main/CONTRIBUTING.md).
 
-It specifies that the reqstool-python-hatch-plugin is a dependency for the build process, and it should be of a specific version. 
+## License
 
-Further it defines the paths where the plugin should be applied. In this case, it specifies that the plugin should be applied to files in the src and tests directories. 
+MIT License.

README.md

@@ -1,4 +1,5 @@
 # yaml-language-server: $schema=https://raw.githubusercontent.com/asciidoctor/asciidoctor-intellij-plugin/main/src/main/resources/jsonSchemas/antoraPlaybookSchema.json
+# For local development only. Published site: https://reqstool.github.io
 
 site:
   title: Reqstool Hatch Plugin Documentation