You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/.feature-template-uno-only.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,6 @@
1
-
1
+
---
2
+
uid: Uno.Doc-Templates.Feature.Uno-only
3
+
---
2
4
<!-- For available Markdown syntax, check out https://guides.github.com/features/mastering-markdown/ -->
3
5
4
6
# YourFeature
@@ -18,7 +20,7 @@
18
20
19
21
<!-- If not feature is supported on every platform, fill in the matrix below to show which ones are supported. If there's no limitations to the feature on any platform, consider removing this whole section. -->
20
22
21
-
| Feature | Windows | Android | iOS | Web (WASM) | macOS | Linux (Skia) | Win 7 (Skia) |
23
+
| Feature | Windows | Android | iOS | Web (WASM) | macOS | Linux (Skia) | Win 7 (Skia) |
Copy file name to clipboardExpand all lines: doc/articles/contributing/Documentation/doc-on-docs.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
uid: Uno.Contributing.Docs
3
3
---
4
4
5
-
# Contributing docs to Uno Platform
5
+
# Contributing Documentation to Uno Platform
6
6
7
7
Good documentation is essential, and writing docs is a valued contribution that makes Uno more useful for everybody. This article covers *when* to write docs and *what* you should write, with a focus on two of the most common forms of documentation: step-by-step guides (ie howtos or tutorials), and feature documentation.
8
8
@@ -12,9 +12,9 @@ For the DocFX tool used to build the docs website, see [more info here](xref:Uno
@@ -29,7 +29,7 @@ Step-by-step guides that address a particular problem or use case that multiple
29
29
30
30
* For longer tutorials, it's fine to split the content over multiple pages.
31
31
* Guides should always be accompanied by working code. Standalone applications should be added to the [Uno.Samples repository](https://github.com/unoplatform/Uno.Samples) and linked to from the associated tutorial.
32
-
* Use the [how-to template](https://github.com/unoplatform/uno/blob/master/doc/.howto-template.md) as a starting point.
32
+
* Use the [how-to template](xref:Uno.Doc-Templates.How-To) as a starting point.
33
33
* Structure guides as a series of clear, actionable steps. After carrying out every step as described, the user should end up with working code that demonstrates the objective of the guide (either a standalone sample, or a new feature in their existing app).
34
34
35
35
## Documenting features
@@ -44,7 +44,7 @@ There's two different cases:
44
44
45
45
Uno's API matches WinUI's API, and most of the time, a new Uno feature will map to an existing WinUI feature.
46
46
47
-
In this case, to the extent that the behavior you're adding is the same as the WinUI behavior, you **don't** need to add documentation. The existing WinUI documentation is fine. It's already linked to from [Uno's reference documentation](../implemented-views.md).
47
+
In this case, to the extent that the behavior you're adding is the same as the WinUI behavior, you **don't** need to add documentation. The existing WinUI documentation is fine. It's already linked to from [Uno's reference documentation](../../implemented-views.md).<!-- xref usage here not possible because UWPSyncGenerator adds none on this file (at least at local doc execution not) -->
48
48
49
49
What if the Uno behavior deviates from WinUI behavior?
50
50
@@ -58,7 +58,7 @@ In those cases, it's important to add documentation. Copy the [WinUI feature tem
58
58
59
59
Rarely, features are added to Uno Platform that aren't part of WinUI (`VisibleBoundsPadding` and `ElevatedView` are two examples). Somewhat more commonly, platform-specific functionality or options are added to an existing feature.
60
60
61
-
It's important to document these novel features when you add them, since they aren't covered anywhere else. Again, copy the [Uno-only feature template here](https://github.com/unoplatform/uno/blob/master/doc/.feature-template-uno-only.md) to the [features directory](https://github.com/unoplatform/uno/tree/master/doc/articles/features) and fill in the sections.
61
+
It's important to document these novel features when you add them, since they aren't covered anywhere else. Again, copy the [Uno-only feature template here](xref:Uno.Doc-Templates.Feature.Uno-Only) to the [features directory](../../features/) and fill in the sections.
62
62
63
63
## Updating the documentation from linked repositories
Copy file name to clipboardExpand all lines: doc/articles/contributing/Documentation/docfx.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,15 +7,13 @@ uid: Uno.Contributing.DocFx
7
7
# The Uno documentation website and DocFX
8
8
9
9
*[TOC]: Table of Contents
10
-
*[HTML]: Hypertext Markup Language
11
10
*[docs]: documentation
12
-
*[doc file]: markdown file
13
11
14
12
Uno Platform's docs website uses [DocFX](https://dotnet.github.io/docfx/) to convert Markdown (.md) files in the [articles folder](https://github.com/unoplatform/uno/tree/master/doc/articles) into [HTML files](xref:Uno.Documentation.Intro).
15
13
16
14
## Linking to the TOC
17
15
18
-
Normally when you add a new doc file, you also add it to [articles/toc.yml](../toc.yml). This allows it to show up in the left sidebar TOC on the docs website.
16
+
Normally when you add a new markdown file, you also add it to [articles/toc.yml](../../toc.yml). This allows it to show up in the left sidebar TOC on the docs website.
0 commit comments