Skip to content
This repository has been archived by the owner on Jan 30, 2024. It is now read-only.

Commit

Permalink
feat: Added initial bikeshed base spec file, added GitHub action to b…
Browse files Browse the repository at this point in the history
…uild and publish the spec
  • Loading branch information
bergos committed Aug 22, 2023
1 parent 7052448 commit ac16238
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Build HTML and publish it to GitHub Pages

on:
push:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
python-version: '3.10'
- run: python3 -m pip install --upgrade pip
- run: python3 -m pip install --upgrade bikeshed && bikeshed update
- run: mkdir public
- run: bikeshed spec index.bs public/index.html
- uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
public/
26 changes: 26 additions & 0 deletions index.bs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<pre class='metadata'>
Title: RDF/JS: SHACL-UI specification
Shortname: shacl-ui
Level: 1
Status: w3c/CG-DRAFT
Group: RDF JavaScript Libraries Community Group
Repository: rdfjs/shacl-ui
URL: https://github.io/rdfjs/shacl-ui/
Editor: Thomas Bergwinkl, https://www.bergnet.org/
Abstract:
This specification introduces an ontology that extends SHACL to define shape-driven UI components and layouts.
Complain About: accidental-2119 yes, missing-example-ids yes
Markup Shorthands: markdown yes, css no
</pre>

# Introduction # {#intro}

*This section is non-normative*

The objective is to enhance the SHACL ontology to cater specifically to the UI use cases for application development and data exploration.
It covers viewing, editing and filtering RDF data.
Interfaces for reusable UI components should be established.
To achieve this, we aim for implementations to rely on the SHACL ontology and the UI extension, enabling them to select UI components and generate layouts.
The foundation for this will be the existing DASH ontology.
The defined interfaces will enable seamless communication between implementations and UI components, enabling efficient viewing, editing or filtering of RDF data.
Whenever feasible, we will utilize other RDF/JS specifications.

0 comments on commit ac16238

Please sign in to comment.