📖 Add CI to docs (#34)

Author: rowanc1

.github/workflows/docs-publish.yml

@@ -0,0 +1,19 @@
+name: Docs Publish
+on:
+  push:
+    branches: ["main"]
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  draft:
+    uses: curvenote/actions/.github/workflows/submit.yml@v1
+    with:
+      venue: oxa
+      kind: docs
+      collection: docs
+      path: docs
+      publish: true
+    secrets:
+      CURVENOTE: ${{ secrets.CURVENOTE_TOKEN }}
+      GITHUB: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs.yml

@@ -0,0 +1,18 @@
+name: Docs Preview
+on:
+  pull_request_target:
+    branches: ["main"]
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  draft:
+    uses: curvenote/actions/.github/workflows/draft.yml@v1
+    with:
+      venue: oxa
+      kind: docs
+      collection: docs
+      path: docs
+    secrets:
+      CURVENOTE: ${{ secrets.CURVENOTE_TOKEN }}
+      GITHUB: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -12,4 +12,3 @@ __pycache__
 
 # Documentation
 docs/_build
-docs/schema

docs/schema/block.md

@@ -0,0 +1,9 @@
+(oxa:block)=
+
+## Block
+
+
+Union of all block content types.
+
+
+Union of: @oxa:heading, @oxa:paragraph

docs/schema/document.md

@@ -0,0 +1,37 @@
+(oxa:document)=
+
+## Document
+
+
+A document with metadata, title, and block content.
+
+
+__type__: _string_, ("Document")
+
+: The type discriminator for Document nodes.
+
+__id__: __string__
+
+: A unique identifier for the node.
+
+__classes__: __array__ ("string")
+
+: A list of class names for styling or semantics.
+
+__data__: __object__
+
+: Arbitrary key-value data attached to the node.
+
+__metadata__: __object__
+
+: Arbitrary document metadata.
+
+__title__: __array__ ("Inline")
+
+: The document title as inline content.
+: See @oxa:inline
+
+__children__: __array__ ("Block")
+
+: The block content of the document.
+: See @oxa:block

docs/schema/heading.md

@@ -0,0 +1,32 @@
+(oxa:heading)=
+
+## Heading
+
+
+A heading with a level and inline content.
+
+
+__type__: _string_, ("Heading")
+
+: The type discriminator for Heading nodes.
+
+__id__: __string__
+
+: A unique identifier for the node.
+
+__classes__: __array__ ("string")
+
+: A list of class names for styling or semantics.
+
+__data__: __object__
+
+: Arbitrary key-value data attached to the node.
+
+__level__: __number__
+
+: The heading level (1-6).
+
+__children__: __array__ ("Inline")
+
+: The inline content of the heading.
+: See @oxa:inline

docs/schema/inline.md

@@ -0,0 +1,9 @@
+(oxa:inline)=
+
+## Inline
+
+
+Union of all inline content types.
+
+
+Union of: @oxa:text, @oxa:strong

docs/schema/paragraph.md

@@ -0,0 +1,28 @@
+(oxa:paragraph)=
+
+## Paragraph
+
+
+A paragraph of inline content.
+
+
+__type__: _string_, ("Paragraph")
+
+: The type discriminator for Paragraph nodes.
+
+__id__: __string__
+
+: A unique identifier for the node.
+
+__classes__: __array__ ("string")
+
+: A list of class names for styling or semantics.
+
+__data__: __object__
+
+: Arbitrary key-value data attached to the node.
+
+__children__: __array__ ("Inline")
+
+: The inline content of the paragraph.
+: See @oxa:inline

docs/schema/strong.md

@@ -0,0 +1,28 @@
+(oxa:strong)=
+
+## Strong
+
+
+Strongly emphasized content (typically bold).
+
+
+__type__: _string_, ("Strong")
+
+: The type discriminator for Strong nodes.
+
+__id__: __string__
+
+: A unique identifier for the node.
+
+__classes__: __array__ ("string")
+
+: A list of class names for styling or semantics.
+
+__data__: __object__
+
+: Arbitrary key-value data attached to the node.
+
+__children__: __array__ ("Inline")
+
+: The inline content to emphasize.
+: See @oxa:inline

docs/schema/text.md

@@ -0,0 +1,27 @@
+(oxa:text)=
+
+## Text
+
+
+A text node containing a string value.
+
+
+__type__: _string_, ("Text")
+
+: The type discriminator for Text nodes.
+
+__id__: __string__
+
+: A unique identifier for the node.
+
+__classes__: __array__ ("string")
+
+: A list of class names for styling or semantics.
+
+__data__: __object__
+
+: Arbitrary key-value data attached to the node.
+
+__value__: __string__
+
+: The text content.