Skip to content

Commit cbd1bf9

Browse files
egekorkanegekorkan
authored
Merge pull request #581 from bobur-khay/design/documentation
Documentation Page
2 parents 8f0bc21 + 7d83c24 commit cbd1bf9

File tree

6 files changed

+84
-89
lines changed

6 files changed

+84
-89
lines changed

‎docs/_layouts/default.html‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -212,18 +212,6 @@ <h2 style="font-size: 22px; color: #005a9c; font-weight: bold">Web of Things</h2
212212
<script src="{{'/js/bootstrap.min.js' | absolute_url }}"></script>
213213
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
214214
<!-- <script src="../../assets/js/ie10-viewport-bug-workaround.js"></script> -->
215-
<script>
216-
// Make all external links open in a new tab
217-
document.addEventListener('DOMContentLoaded', function () {
218-
var links = document.getElementsByTagName('a');
219-
for (var i = 0; i < links.length; i++) {
220-
if (links[i].hostname && links[i].hostname !== window.location.hostname) {
221-
links[i].target = '_blank';
222-
links[i].rel = 'noopener noreferrer';
223-
}
224-
}
225-
});
226-
</script>
227215
</div>
228216
<!-- outer container -->
229217
</body>

‎docs/about/articles/index.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,7 @@ <h2>Articles</h2>
4141
<td style="text-align: left; vertical-align: middle">{{ article.publisher }}</td>
4242
<td style="text-align: left; vertical-align: middle; white-space: nowrap">{{ article.date }}</td>
4343
<td style="text-align: center; vertical-align: middle">
44-
<a href="{{ article.url }}" target="_blank" rel="noopener noreferrer"
45-
><i class="fas fa-external-link-alt"></i
46-
></a>
44+
<a href="{{ article.url }}" rel="noopener noreferrer"><i class="fas fa-external-link-alt"></i></a>
4745
</td>
4846
</tr>
4947
{% endfor %}

‎docs/developers/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ <h3 id="toolDialogName" style="margin-top: 0; padding-right: 24px"></h3>
312312
homeDiv.innerHTML =
313313
'<div><i class="fas fa-home" style="width: 24px; font-size: 1.1em; text-align: center; color: #555;"></i> <strong>Homepage</strong></div><div style="margin-left: 4px; margin-top: 2px;"><a href="' +
314314
homepage +
315-
'" target="_blank" style="word-break: break-all;">' +
315+
'" style="word-break: break-all;">' +
316316
homepage +
317317
'</a></div>';
318318
linksDiv.appendChild(homeDiv);
@@ -333,7 +333,7 @@ <h3 id="toolDialogName" style="margin-top: 0; padding-right: 24px"></h3>
333333
repoIcon +
334334
' <strong>Repository</strong></div><div style="margin-left: 4px; margin-top: 2px;"><a href="' +
335335
repo +
336-
'" target="_blank" style="word-break: break-all;">' +
336+
'" style="word-break: break-all;">' +
337337
repo +
338338
'</a></div>';
339339
linksDiv.appendChild(repoDiv);

‎docs/documentation/index.html‎

Lines changed: 77 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,94 @@
55
---
66

77
<div>
8+
<h2>Foundations</h2>
9+
<p style="margin-bottom: 16px">
10+
New to the Web of Things? These beginner-friendly community-based tutorials will help you understand the core
11+
concepts behind WoT and get you up to speed quickly. Whether you're a developer, researcher, or just curious, these
12+
are the best place to start.
13+
</p>
14+
15+
<div class="row" style="display: flex; flex-wrap: wrap; margin-bottom: 32px">
16+
<div class="col-md-4 col-sm-12" style="margin-bottom: 20px">
17+
<div class="panel panel-default" style="display: flex; flex-direction: column; height: 100%; margin-bottom: 0">
18+
<div class="panel-heading">
19+
<h3 class="panel-title">What is WoT?</h3>
20+
</div>
21+
<div class="panel-body" style="display: flex; flex-direction: column; flex-grow: 1">
22+
<p style="margin-bottom: 20px">
23+
A gentle introduction to the Web of Things. Learn what WoT is all about, why it matters, and how it connects
24+
everyday devices to the Web using open standards.
25+
</p>
26+
<a
27+
href="https://w3c.github.io/wot-cg/tutorials/whatiswot/"
28+
class="btn btn-primary"
29+
style="margin-top: auto; align-self: flex-start"
30+
>
31+
Start the Tutorial &raquo;
32+
</a>
33+
</div>
34+
</div>
35+
</div>
36+
37+
<div class="col-md-4 col-sm-12" style="margin-bottom: 20px">
38+
<div class="panel panel-default" style="display: flex; flex-direction: column; height: 100%; margin-bottom: 0">
39+
<div class="panel-heading">
40+
<h3 class="panel-title">Thing Description 1.1 Explainer</h3>
41+
</div>
42+
<div class="panel-body" style="display: flex; flex-direction: column; flex-grow: 1">
43+
<p style="margin-bottom: 20px">
44+
Understand the Thing Description (TD) — the cornerstone of WoT. This explainer walks you through how TDs
45+
describe the capabilities, interfaces, and metadata of connected devices in a machine-readable format.
46+
</p>
47+
<a
48+
href="https://github.com/w3c/wot-thing-description/blob/main/explainer/Explainer11.md"
49+
class="btn btn-primary"
50+
style="margin-top: auto; align-self: flex-start"
51+
>
52+
Read the Explainer &raquo;
53+
</a>
54+
</div>
55+
</div>
56+
</div>
57+
58+
<div class="col-md-4 col-sm-12" style="margin-bottom: 20px">
59+
<div class="panel panel-default" style="display: flex; flex-direction: column; height: 100%; margin-bottom: 0">
60+
<div class="panel-heading">
61+
<h3 class="panel-title">WoT Discovery Explainer</h3>
62+
</div>
63+
<div class="panel-body" style="display: flex; flex-direction: column; flex-grow: 1">
64+
<p style="margin-bottom: 20px">
65+
Learn how devices and services find each other on the Web of Things. This explainer covers the WoT Discovery
66+
mechanism, which makes it easy to search for and locate Thing Descriptions across networks.
67+
</p>
68+
<a
69+
href="https://github.com/w3c/wot-discovery/blob/main/explainer/Explainer.md"
70+
class="btn btn-primary"
71+
style="margin-top: auto; align-self: flex-start"
72+
>
73+
Read the Explainer &raquo;
74+
</a>
75+
</div>
76+
</div>
77+
</div>
78+
</div>
79+
880
<h2>Documentation</h2>
981
<p>
1082
The W3C WoT Working Group publishes and maintains a suite of documents that define the Web of Things. These are
1183
categorized into normative specifications and informative deliverables. The tables below provide an overview of our
1284
current deliverables and their publication status.
1385
</p>
14-
1586
<div class="row center-block">
16-
<div class="col-md-12 text-center">
87+
<div class="col-md-12" style="padding: 0">
1788
<h3>Normative Deliverables</h3>
1889
<!-- <p></p> -->
19-
<table style="margin-bottom: 40px; border-radius: 10px; text-align: left" class="table table-bordered">
90+
<table style="margin-bottom: 16px; border-radius: 10px; text-align: left" class="table table-bordered">
2091
<thead>
2192
<tr>
2293
<th>Deliverable</th>
2394
<th>Status</th>
24-
<th>Last Publication</th>
95+
<th style="width: 180px">Last Publication</th>
2596
</tr>
2697
</thead>
2798
<tbody>
@@ -96,14 +167,14 @@ <h3>Normative Deliverables</h3>
96167
</table>
97168
</div>
98169

99-
<div class="col-md-12 text-center">
170+
<div class="col-md-12" style="padding: 0">
100171
<h3>Informative Deliverables</h3>
101172
<!-- <p></p> -->
102173
<table style="margin-bottom: 40px; border-radius: 10px; text-align: left" class="table table-bordered">
103174
<thead>
104175
<tr>
105176
<th>Deliverable</th>
106-
<th>Last Public Note</th>
177+
<th style="width: 180px">Last Public Note</th>
107178
</tr>
108179
</thead>
109180
<tbody>
@@ -143,42 +214,4 @@ <h3>Informative Deliverables</h3>
143214
</table>
144215
</div>
145216
</div>
146-
147-
<div class="row">
148-
<p>&nbsp;</p>
149-
</div>
150-
151-
<h3 id="further-reading">Further Reading</h3>
152-
<div class="row">
153-
<div class="col-md-12">
154-
<p>
155-
For further reading, please find below a set of links to a variety of additional material including
156-
presentations and documents.
157-
</p>
158-
159-
<!--<h4>Social Media</h4>
160-
<ul>
161-
<li><a href="https://twitter.com/W3C_WoT">Twitter</a></li>
162-
<li><a href="#">Youtube ?? LINK ??</a></li>
163-
<li><a href="https://twitter.com/W3C_WoT">node-wot Videos</a></li>
164-
</ul>-->
165-
166-
<h4>Introductory Materials (Explainers)</h4>
167-
<ul>
168-
<li>
169-
<a href="https://github.com/w3c/wot-thing-description/blob/main/explainer/Explainer11.md"
170-
>Thing Description 1.1</a
171-
>
172-
</li>
173-
<li>
174-
<a href="https://github.com/w3c/wot-discovery/blob/main/explainer/Explainer.md">Discovery</a>
175-
</li>
176-
</ul>
177-
178-
<h4>Other Material</h4>
179-
<ul>
180-
<li><a href="https://www.w3.org/2020/10/TPAC/group-updates.html#wot">TPAC 2020 - WoT Summary</a></li>
181-
</ul>
182-
</div>
183-
</div>
184217
</div>

‎docs/participate/working-group/index.html‎

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ <h2>W3C WoT – Working Group</h2>
5656
<a
5757
href="https://www.w3.org/2004/01/pp-impl/95969/instructions"
5858
class="participate-card-link"
59-
target="_blank"
6059
rel="noopener noreferrer"
6160
>
6261
<div class="participate-card" style="position: relative">
@@ -72,12 +71,7 @@ <h3 style="margin-top: 0">Join</h3>
7271
</a>
7372
</div>
7473
<div class="col-xs-12 col-sm-6 col-md-6" style="margin-bottom: 20px">
75-
<a
76-
href="https://www.w3.org/2023/10/wot-wg-2023.html"
77-
class="participate-card-link"
78-
target="_blank"
79-
rel="noopener noreferrer"
80-
>
74+
<a href="https://www.w3.org/2023/10/wot-wg-2023.html" class="participate-card-link" rel="noopener noreferrer">
8175
<div class="participate-card" style="position: relative">
8276
<i
8377
class="fas fa-external-link-alt"
@@ -97,7 +91,6 @@ <h3 style="margin-top: 0">WG Charter</h3>
9791
<a
9892
href="https://lists.w3.org/Archives/Member/member-wot-wg/"
9993
class="participate-card-link"
100-
target="_blank"
10194
rel="noopener noreferrer"
10295
>
10396
<div class="participate-card" style="position: relative">
@@ -113,12 +106,7 @@ <h3 style="margin-top: 0">Mailing List</h3>
113106
</a>
114107
</div>
115108
<div class="col-xs-12 col-sm-6 col-md-6" style="margin-bottom: 20px">
116-
<a
117-
href="https://www.w3.org/groups/wg/wot/participants"
118-
class="participate-card-link"
119-
target="_blank"
120-
rel="noopener noreferrer"
121-
>
109+
<a href="https://www.w3.org/groups/wg/wot/participants" class="participate-card-link" rel="noopener noreferrer">
122110
<div class="participate-card" style="position: relative">
123111
<i
124112
class="fas fa-external-link-alt"

‎docs/participate/working-group/interest-group/index.html‎

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ <h2>W3C WoT – Interest Group</h2>
6363
<a
6464
href="https://www.w3.org/2004/01/pp-impl/75874/instructions"
6565
class="participate-card-link"
66-
target="_blank"
6766
rel="noopener noreferrer"
6867
>
6968
<div class="participate-card" style="position: relative">
@@ -79,12 +78,7 @@ <h3 style="margin-top: 0">Join</h3>
7978
</a>
8079
</div>
8180
<div class="col-xs-12 col-sm-6 col-md-6" style="margin-bottom: 20px">
82-
<a
83-
href="https://www.w3.org/2024/04/wot-ig-2024.html"
84-
class="participate-card-link"
85-
target="_blank"
86-
rel="noopener noreferrer"
87-
>
81+
<a href="https://www.w3.org/2024/04/wot-ig-2024.html" class="participate-card-link" rel="noopener noreferrer">
8882
<div class="participate-card" style="position: relative">
8983
<i
9084
class="fas fa-external-link-alt"
@@ -101,12 +95,7 @@ <h3 style="margin-top: 0">IG Charter</h3>
10195

10296
<div class="row" style="display: flex; flex-wrap: wrap">
10397
<div class="col-xs-12 col-sm-6 col-md-6" style="margin-bottom: 20px">
104-
<a
105-
href="https://www.w3.org/groups/ig/wot/participants"
106-
class="participate-card-link"
107-
target="_blank"
108-
rel="noopener noreferrer"
109-
>
98+
<a href="https://www.w3.org/groups/ig/wot/participants" class="participate-card-link" rel="noopener noreferrer">
11099
<div class="participate-card" style="position: relative">
111100
<i
112101
class="fas fa-external-link-alt"
@@ -123,7 +112,6 @@ <h3 style="margin-top: 0">Participants</h3>
123112
<a
124113
href="https://lists.w3.org/Archives/Public/public-wot-ig/"
125114
class="participate-card-link"
126-
target="_blank"
127115
rel="noopener noreferrer"
128116
>
129117
<div class="participate-card" style="position: relative">

0 commit comments

Comments
 (0)