Skip to content

Commit 5930999

Browse files
ihe-devices-automation[bot]ihe-devices-automation[bot]
authored
Initial commit
0 parents  commit 5930999

13 files changed

Lines changed: 348 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/content-issue.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Content Issue
3+
about: Report an error or suggest a change to supplement content
4+
labels: content
5+
---
6+
7+
## Section
8+
9+
<!-- Which section(s) does this relate to? e.g., "Volume 1, Section 3.2.1" -->
10+
11+
## Description
12+
13+
<!-- Describe the issue or proposed change. -->
14+
15+
## Suggested Fix (if applicable)
16+
17+
<!-- If you have a specific correction in mind, describe it here. -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## What This PR Does
2+
3+
<!-- Briefly describe the change. -->
4+
5+
## Why
6+
7+
<!-- What motivated this change? Reference any CP numbers, issue numbers, or committee decisions. -->
8+
9+
## Sections Changed
10+
11+
<!-- List the sections or volumes affected (e.g., "Volume 1, Section 3.2"). -->
12+
13+
## Checklist
14+
15+
- [ ] AsciiDoc renders correctly (CI build passes)
16+
- [ ] Cross-references are valid
17+
- [ ] Any new images are included in `images/`
18+
- [ ] Commit messages are descriptive

‎.github/workflows/publish.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: Build
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout supplement
17+
uses: actions/checkout@v4
18+
19+
- name: Checkout shared theme
20+
uses: actions/checkout@v4
21+
with:
22+
repository: IHE/DEV.tooling
23+
path: .tooling
24+
sparse-checkout: theme
25+
26+
- name: Setup Ruby
27+
uses: ruby/setup-ruby@v1
28+
with:
29+
ruby-version: '3.3'
30+
bundler-cache: true
31+
32+
- name: Install Asciidoctor
33+
run: |
34+
gem install asciidoctor asciidoctor-pdf
35+
36+
- name: Prepare theme
37+
run: |
38+
mkdir -p output
39+
40+
# Combine base CSS + per-repo CSS (cascading, not replacing)
41+
cat .tooling/theme/ihe-base.css > output/combined.css
42+
if [ -f AsciiDoc_Source/theme/custom.css ]; then
43+
echo "" >> output/combined.css
44+
echo "/* === Per-repo custom styles === */" >> output/combined.css
45+
cat AsciiDoc_Source/theme/custom.css >> output/combined.css
46+
fi
47+
48+
# Copy base PDF theme where asciidoctor-pdf can find it
49+
cp .tooling/theme/ihe-base-theme.yml output/ihe-base-theme.yml
50+
51+
- name: Build HTML
52+
run: |
53+
asciidoctor \
54+
-b html5 \
55+
-a stylesheet=../output/combined.css \
56+
-a linkcss \
57+
-D output \
58+
-o index.html \
59+
AsciiDoc_Source/main.adoc
60+
61+
- name: Build PDF
62+
run: |
63+
asciidoctor-pdf \
64+
-a pdf-theme=output/ihe-base-theme.yml \
65+
-D output \
66+
-o supplement.pdf \
67+
AsciiDoc_Source/main.adoc
68+
69+
- name: Clean up build files
70+
run: |
71+
# Remove intermediate files from the artifact
72+
rm -f output/ihe-base-theme.yml
73+
74+
- name: Upload build artifacts
75+
uses: actions/upload-artifact@v4
76+
with:
77+
name: supplement-output
78+
path: output/
79+
retention-days: 90

‎.gitignore‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Build output
2+
output/
3+
4+
# OS files
5+
.DS_Store
6+
Thumbs.db
7+
8+
# Editor files
9+
*.swp
10+
*.swo
11+
*~
12+
.vscode/
13+
.idea/

‎AsciiDoc_Source/main.adoc‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
= {supplement-title}
2+
:doctype: book
3+
4+
include::metadata.adoc[]
5+
6+
[discrete]
7+
== Supplement Information
8+
9+
[cols="1,3"]
10+
|===
11+
| *Domain* | {supplement-domain}
12+
| *Status* | {supplement-status}
13+
| *Revision* | {supplement-revision}
14+
| *Date* | {supplement-date}
15+
| *Editor* | {supplement-editor}
16+
|===
17+
18+
<<<
19+
20+
== Introduction
21+
22+
// Brief introduction to this supplement. What problem does it solve?
23+
// What gap in the Technical Framework does it address?
24+
25+
This supplement to the IHE Devices Technical Framework defines...
26+
27+
=== Open Issues and Questions
28+
29+
// Track open issues here during development. Remove this section before Final Text.
30+
31+
. _Example: Should the Device Observer actor be required to support both push and pull?_
32+
33+
=== Closed Issues
34+
35+
// Record resolved issues here for traceability. Remove this section before Final Text.
36+
37+
// None yet.
38+

‎AsciiDoc_Source/metadata.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Supplement metadata — update these attributes for your supplement
2+
:supplement-title: {{SUPPLEMENT_TITLE}}
3+
:supplement-short: {{SHORT_NAME}}
4+
:supplement-status: Draft
5+
:supplement-revision: 0.1
6+
:supplement-date: {{DATE}}
7+
:supplement-domain: IHE Devices (DEV)
8+
:supplement-editor: {{EDITOR_NAME}}
9+
10+
// Standard IHE document attributes
11+
:toc: left
12+
:toclevels: 3
13+
:sectnums:
14+
:sectnumlevels: 4
15+
:icons: font
16+
:imagesdir: ../images
17+
:data-uri:

‎AsciiDoc_Source/theme/custom.css‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/*
2+
* Per-repo custom stylesheet
3+
*
4+
* This file is for styling specific to THIS supplement only.
5+
* It is applied AFTER the shared IHE base stylesheet from DEV.tooling,
6+
* so anything you add here cascades on top of the base styles.
7+
*
8+
* Use this for things like:
9+
* - Custom colors for a specific diagram convention
10+
* - Adjustments to table widths for this document's content
11+
* - Any visual tweaks unique to this supplement
12+
*
13+
* You do NOT need to repeat the base styles here. Only add rules
14+
* that are specific to this particular document.
15+
*
16+
* If this file is empty or contains only comments, it has no effect
17+
* and the base theme is used as-is.
18+
*/

‎CONTRIBUTING.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing to This Supplement
2+
3+
Thank you for contributing to IHE Devices domain work.
4+
5+
## How to Contribute
6+
7+
1. **Get access:** Ask the Domain Lead to add you to the `Devices-Domain` team.
8+
2. **Create a branch:** Never commit directly to `main`. Create a feature branch.
9+
3. **Make your changes:** Edit the `.adoc` files in `AsciiDoc_Source/`.
10+
4. **Open a Pull Request:** Push your branch and open a PR on GitHub.
11+
5. **Review:** A reviewer will look at your changes and provide feedback.
12+
6. **Merge:** Once approved and CI passes, the PR will be merged.
13+
14+
## Commit Messages
15+
16+
Use imperative mood and describe what you did:
17+
- "Add actor definitions for Device Observer"
18+
- "Fix table numbering in section 3.2"
19+
- "Update conformance language per committee feedback"
20+
21+
## Questions?
22+
23+
- **Content questions:** Discuss in PR comments
24+
- **Process questions:** Ask the Domain Lead
25+
- **Template/tooling issues:** File an issue on [DEV.tooling](https://github.com/IHE/DEV.tooling)

‎CP/Approved/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Approved Change Proposals
2+
3+
Change Proposals that have **passed a ballot** are moved here from the parent
4+
[`CP/`](../) directory.
5+
6+
See the [Change Proposal (CP) Workflow](https://github.com/IHE/DEV.documentation/blob/main/playbooks/cp-workflow.md)
7+
for the full process.
8+
9+
> This README also keeps the otherwise-empty `CP/Approved/` directory in git.
10+
> Leave it in place.

‎CP/README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Change Proposals (CPs)
2+
3+
This directory holds the Change Proposals for this document.
4+
5+
```
6+
CP/ ← CPs currently in progress (one file per CP)
7+
CP/Approved/ ← CPs that have passed a ballot
8+
```
9+
10+
- A CP **in progress** lives directly in `CP/`.
11+
- A CP that has **passed its ballot** moves into [`CP/Approved/`](Approved/).
12+
13+
## How CPs work
14+
15+
The full process — creating a CP so it's visible on `main`, doing the work on a
16+
CP branch, opening a PR when it's ready to ballot, and moving approved CPs into
17+
`CP/Approved/` — is documented in the Devices domain documentation:
18+
19+
**→ [Change Proposal (CP) Workflow](https://github.com/IHE/DEV.documentation/blob/main/playbooks/cp-workflow.md)**
20+
21+
> This README is also what keeps the otherwise-empty `CP/` directory in git.
22+
> Leave it in place.

0 commit comments

Comments
 (0)