DOC Prepare for docs site

Author: emteknetnz

.doclintrc

@@ -0,0 +1 @@
+docs/en/

README.md

@@ -13,7 +13,7 @@ composer require silverstripe/tagfield
 
 ## Overview
 
-![Screenshot](docs/en/screenshot.png)
+![Screenshot](docs/en/_images/screenshot.png)
 
 Allows storing tags as a relationship, or comma-delimited strings.
 Supports autocompletion with lazy-loading.

composer.json

@@ -27,6 +27,7 @@
         "phpunit/phpunit": "^9.6",
         "squizlabs/php_codesniffer": "^3",
         "silverstripe/standards": "^1",
+        "silverstripe/documentation-lint": "^1",
         "phpstan/extension-installer": "^1.3"
     },
     "autoload": {
@@ -40,6 +41,11 @@
             "client/dist"
         ]
     },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    },
     "minimum-stability": "dev",
     "prefer-stable": true
 }

docs/en/using.md docs/en/01_usage.mddocs/en/using.md renamed to docs/en/01_usage.md

@@ -1,54 +1,68 @@
-# Using
+---
+title: TagField Module Usage
+summary: Managing tags on DataObjects, and integration with silverstripe-taxonomy
+icon: tags
+---
+
+# Usage
 
 The primary use, for this module, is as a custom input field interface. For instance, imagine you had the following data objects:
 
 ```php
+namespace App\Models;
+
 class BlogPost extends DataObject
 {
-	private static $many_many = array(
-		'BlogTags' => 'SilverStripe\\Blog\\Model\\BlogTag'
-	);
+    private static $many_many = [
+        'BlogTags' => BlogTag::class,
+    ];
 }
+```
+
+```php
+namespace App\Models;
 
 class BlogTag extends DataObject
 {
-	private static $db = array(
-		'Title' => 'Varchar(200)'
-	);
+    private static $db = [
+        'Title' => 'Varchar(200)',
+    ];
 
-	private static $belongs_many_many = array(
-		'BlogPosts' => 'SilverStripe\\Blog\\Model\\BlogPost'
-	);
+    private static $belongs_many_many = [
+        'BlogPosts' => BlogPost::class,
+    ];
 }
 ```
 
-If you wanted to link blog tags to blog posts, you might override `getCMSFields` with the following field:
+If you wanted to link blog tags to blog posts, you might override [`DataObject::getCMSFields()`](api:SilverStripe\ORM\DataObject::getCMSFields()) with the following field:
 
 ```php
 $field = TagField::create(
-	'BlogTags',
-	'Blog Tags',
-	BlogTag::get(),
-	$this->BlogTags()
+    'BlogTags',
+    'Blog Tags',
+    BlogTag::get(),
+    $this->BlogTags()
 )
-	->setShouldLazyLoad(true) // tags should be lazy loaded
-	->setCanCreate(true);     // new tag DataObjects can be created
+    // tags should be lazy loaded
+    ->setShouldLazyLoad(true)
+    // new tag DataObjects can be created
+    ->setCanCreate(true);
 ```
 
 **Note:** This assumes you have imported the namespaces class, e.g. `use SilverStripe\TagField\TagField;`.
 
 This will present a tag field, in which you can select existing blog tags or create new ones. They will be created/linked after the blog posts are saved.
 
-### StringTagField
+## StringTagField
 
 You can also store string-based tags, with the following field type:
 
 ```php
 $field = StringTagField::create(
-	'Tags',
-	'Tags',
-	['one', 'two'],
-	explode(',', $this->Tags)
+    'Tags',
+    'Tags',
+    ['one', 'two'],
+    explode(',', $this->Tags)
 )
     ->setCanCreate(true)
     ->setShouldLazyLoad(true);
@@ -57,28 +71,30 @@ $field = StringTagField::create(
 This assumes you are storing tags in the following data object structure:
 
 ```php
+namespace App\Models;
+
 class BlogPost extends DataObject
 {
     private static $db = [
         'Tags' => 'Text',
-	];
+    ];
 }
 ```
 
 In the above code example, the options available (whether lazy loaded or not) would be "one" and "two", and the
 user would be able to create new options. Whichever tags are chosen would be stored in the BlogPost's `Tags` field
 as a comma-delimited string.
 
-## Using TagField with silverstripe-taxonomy
+## Using tagfield with silverstripe-taxonomy
 
-TagField assumes a `Title` field on objects. For classes without a `Title` field
-use `setTitleField` to modify accordingly.
+TagField assumes that objects have a `Title` field. For classes without a `Title` field
+use [`TagField::setTitleField()`](api:SilverStripe\TagField\TagField::setTitleField()) to modify accordingly.
 
 ```php
 $field = TagField::create(
     'Tags',
     'Blog Tags',
-    TaxonomyTerm::get(),
+    TaxonomyTerm::get()
 )
     ->setTitleField('Name');
 ```

docs/en/screenshot.png docs/en/_images/screenshot.pngdocs/en/screenshot.png renamed to docs/en/_images/screenshot.png

@@ -0,0 +1,21 @@
+---
+title: TagField
+summary: Provides a custom form field for adding tags to content, supporting either related data objects or simple string-based tags
+icon: tags
+---
+
+# TagField
+
+The TagField module provides a custom form field for adding tags to content. It supports creating tags as related data objects or as a simple comma-separated list of strings.
+
+## Installation
+
+```bash
+composer require silverstripe/tagfield
+```
+
+## GitHub repository
+
+<https://github.com/silverstripe/silverstripe-tagfield>
+
+[CHILDREN]