Add GitHub community files and Documentation

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: ra1028

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,66 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      options:
+        - label: This is not a bug caused by platform.
+          required: true
+        - label: Reviewed the README and documentation.
+          required: true
+        - label: Checked existing issues & PRs to ensure not duplicated.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: What happened?
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Reproduction Steps
+      value: |
+        1.
+        2.
+        3.
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Swift Version
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Library Version
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Platform
+      multiple: true
+      options:
+        - iOS
+        - tvOS
+        - macOS
+        - watchOS
+
+  - type: textarea
+    attributes:
+      label: Scrrenshot/Video/Gif
+      placeholder: |
+        Drag and drop screenshot, video, or gif here if you have.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/documentation_request.yml

@@ -0,0 +1,27 @@
+name: Documentation Request
+description: Suggest a new doc/example or ask a question about an existing one
+title: "[Doc Request]: "
+labels: ["documentation"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      options:
+        - label: Reviewed the README and documentation.
+          required: true
+        - label: Confirmed that this is uncovered by existing docs or examples.
+          required: true
+        - label: Checked existing issues & PRs to ensure not duplicated.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Description
+      placeholder: Describe what the scenario you think is uncovered by the existing ones and why you think it should be covered.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Motivation & Context
+      placeholder: Feel free to describe any additional context, such as why you thought the scenario should be covered.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,42 @@
+name: Feature Request
+description: Suggest a new idea of feature
+title: "[Feat Request]: "
+labels: ["enhancement"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      options:
+        - label: Reviewed the README and documentation.
+          required: true
+        - label: Checked existing issues & PRs to ensure not duplicated.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Description
+      placeholder: Describe the feature that you want to propose.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Example Use Case
+      placeholder: Describe an example use case that the feature is useful.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Alternative Solution
+      placeholder: Describe alternatives solutions that you've considered.
+
+  - type: textarea
+    attributes:
+      label: Proposed Solution
+      placeholder: Describe how we can achieve the feature you'd like to suggest.
+
+  - type: textarea
+    attributes:
+      label: Motivation & Context
+      placeholder: Feel free to describe any additional context, such as why you want to suggest this feature.

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+## Pull Request Type
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Refactoring
+- [ ] Documentation update
+- [ ] Chore
+
+## Issue for this PR
+
+Link:
+
+## Description
+
+## Motivation and Context
+
+## Impact on Existing Code
+
+## Screenshot/Video/Gif

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+# https://github.com/actions/virtual-environments
+
+name: docs
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Test
+    runs-on: macos-12
+    strategy:
+      matrix:
+        xcode_version:
+          - 13.3
+    env:
+      DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode_version }}.app
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build docs
+        run: make docs
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs

.gitignore

@@ -19,7 +19,6 @@ DerivedData
 build/
 archive/
 *.xcframework
-
-## SwiftPM
 .swiftpm
 .build
+docs

Makefile

@@ -18,6 +18,24 @@ format:
 lint:
 	$(TOOL) swift-format lint -s -p -r $(SWIFT_FILE_PATHS)
 
+.PHONY: docs
+docs:
+	$(PACKAGE) \
+	  --allow-writing-to-directory docs \
+	  generate-documentation \
+	  --product Hooks \
+	  --disable-indexing \
+	  --transform-for-static-hosting \
+	  --hosting-base-path swiftui-hooks \
+	  --output-path docs
+
+.PHONY: docs-preview
+docs-preview:
+	$(PACKAGE) \
+	  --disable-sandbox \
+	  preview-documentation \
+	  --product Hooks
+
 .PHONY: test
 test: test-library build-examples
 

README.md

@@ -1,6 +1,7 @@
 <h1 align="center">SwiftUI Hooks</h1>
 <p align="center">A SwiftUI implementation of <a href="https://reactjs.org/docs/hooks-intro.html">React Hooks</a>.</p>
 <p align="center">Enhances reusability of stateful logic and gives state and lifecycle to function view.</p>
+<p align="center"><a href="https://ra1028.github.io/SwiftUI-Hooks/documentation/hooks">📔 API Reference</a></p>
 <p align="center">
   <a href="https://github.com/ra1028/SwiftUI-Hooks/actions"><img alt="test" src="https://github.com/ra1028/SwiftUI-Hooks/workflows/test/badge.svg"></a>
   <a href="https://github.com/ra1028/SwiftUI-Hooks/releases/latest"><img alt="release" src="https://img.shields.io/github/v/release/ra1028/SwiftUI-Hooks.svg"/></a>
@@ -100,6 +101,11 @@ And then, include "Hooks" as a dependency for your target:
 ]),
 ```
 
+### Documentation
+
+- [API Reference](https://ra1028.github.io/SwiftUI-Hooks/documentation/hooks)
+- [Example apps](Examples)
+
 ---
 
 ## Hooks API

Sources/Hooks/Hooks.docc/Hooks.md

@@ -0,0 +1,51 @@
+# ``Hooks``
+
+🪝 A SwiftUI implementation of React Hooks. Enhances reusability of stateful logic and gives state and lifecycle to function view.
+
+## Overview
+
+SwiftUI Hooks is a SwiftUI implementation of React Hooks. Brings the state and lifecycle into the function view, without depending on elements that are only allowed to be used in struct views such as @State or @ObservedObject.
+It allows you to reuse stateful logic between views by building custom hooks composed with multiple hooks.
+Furthermore, hooks such as useEffect also solve the problem of lack of lifecycles in SwiftUI.
+
+## Source Code
+
+<https://github.com/ra1028/SwiftUI-Hooks>
+
+## Topics
+
+### Hooks
+
+- ``useState(_:)``
+- ``useEffect(_:_:)``
+- ``useLayoutEffect(_:_:)``
+- ``useMemo(_:_:)``
+- ``useRef(_:)``
+- ``useReducer(_:initialState:)``
+- ``useEnvironment(_:)``
+- ``usePublisher(_:_:)``
+- ``usePublisherSubscribe(_:)``
+- ``useContext(_:)``
+
+### User Interface
+
+- ``HookScope``
+- ``HookView``
+
+### Values
+
+- ``Context``
+- ``AsyncPhase``
+- ``RefObject``
+- ``HookUpdateStrategy``
+
+### Testing
+
+- ``HookTester``
+
+### Internal System
+
+- ``useHook(_:)``
+- ``Hook``
+- ``HookCoordinator``
+- ``HookDispatcher``

Tools/Package.resolved

@@ -63,6 +63,15 @@
         "version" : "1.1.2"
       }
     },
+    {
+      "identity" : "swift-docc-plugin",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-docc-plugin",
+      "state" : {
+        "revision" : "3303b164430d9a7055ba484c8ead67a52f7b74f6",
+        "version" : "1.0.0"
+      }
+    },
     {
       "identity" : "swift-format",
       "kind" : "remoteSourceControl",

Tools/Package.swift

@@ -5,6 +5,8 @@ import PackageDescription
 let package = Package(
     name: "Tools",
     dependencies: [
+        .package(name: "SwiftUI-Hooks", path: ".."),
+        .package(url: "https://github.com/apple/swift-docc-plugin", exact: "1.0.0"),
         .package(url: "https://github.com/apple/swift-format.git", exact: "0.50600.0"),
         .package(url: "https://github.com/yonaskolb/XcodeGen.git", exact: "2.28.0"),
     ]