Skip to content

Commit 3cd3654

Browse files
committed
update maui readme
1 parent ee139ee commit 3cd3654

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,41 @@
11
---
2-
title: Telerik Xamarin Documentation Repo
2+
title: Telerik MAUI Documentation Repo
33
publish: false
44
---
55

66

7-
# Telerik UI for Xamarin Public Documentation
7+
# Telerik UI for MAUI Public Documentation
88

9-
Welcome to the GitHub repo for [Telerik UI for Xamarin](http://docs.telerik.com/devtools/xamarin) documentation. This repository contains the source content — written in Markdown — that we use to power the Telerik UI for Xamarin Documentation at [docs.telerik.com/devtools/xamarin](http://docs.telerik.com/devtools/xamarin). If you've arrived here wanting to search and peruse our docs, you'd be better served heading over to [docs.telerik.com/devtools/xamarin/](http://docs.telerik.com/devtools/xamarin) where our content is prettified and searchable.
9+
Welcome to the GitHub repo for [Telerik UI for MAUI](http://docs.telerik.com/devtools/maui) documentation. This repository contains the source content — written in Markdown — that we use to power the Telerik UI for MAUI Documentation at [docs.telerik.com/devtools/maui](http://docs.telerik.com/devtools/maui). If you've arrived here wanting to search and peruse our docs, you'd be better served heading over to [docs.telerik.com/devtools/maui/](http://docs.telerik.com/devtools/maui) where our content is prettified and searchable.
1010

1111
We believe that the documentation for a product is at its best when the content is a collaboration between the builders and consumers of that product. As such, this documentation is both public, and open sourced under and MIT license (see below). That means you can clone this repository, read the docs off line, or even load the entire thing to an Apple Newton, if that's your thing.
1212

13-
It also means that you can play a role in making our docs better for everyone, and if helping us make the Telerik UI for Xamarin docs better sounds interesting to you, read on.
13+
It also means that you can play a role in making our docs better for everyone, and if helping us make the Telerik UI for MAUI docs better sounds interesting to you, read on.
1414

1515
## Contributing
1616

17-
There are two ways you can contribute to the public Telerik UI for Xamarin documentation: either create an issue in this repository, or fork the repo, make the change and send us a pull request!
17+
There are two ways you can contribute to the public Telerik UI for MAUI documentation: either create an issue in this repository, or fork the repo, make the change and send us a pull request!
1818

19-
* **Create an issue** - If you find an issue with our docs that needs to be addressed, the best way to let us know about it is by [creating an issue in this repository](https://github.com/telerik/Xamarin-Forms-docs/issues?state=open). When creating an issue, provide a descriptive title, be as specific as possible and link to the document in question (If you can provide a link to the closest anchor to the issue, all the better). Here's an example:
19+
* **Create an issue** - If you find an issue with our docs that needs to be addressed, the best way to let us know about it is by [creating an issue in this repository](https://github.com/telerik/maui-docs/issues?state=open). When creating an issue, provide a descriptive title, be as specific as possible and link to the document in question (If you can provide a link to the closest anchor to the issue, all the better). Here's an example:
2020

2121
Title: api/DataViz/chart.md is missing an image
22-
Description : Example 3 is missing an image right after the code sample. https://github.com/telerik/Xamarin-Forms-docs/issues?state=open
22+
Description : Example 3 is missing an image right after the code sample. https://github.com/telerik/maui-docs/issues?state=open
2323

2424
> Note: When creating issues, please don't modify the assignee or milestone fields. Also, please create one issue per fix or change. "Bundled" entries will be deleted.
2525
2626
* **Send us a pull request** - Creating an issue is great — and we certainly appreciate them — but what we really love are pull requests. So, if you find an issue in the docs, or even feel like creating new content, we'd be happy to have your contributions! If you're just getting started with open source, Git and GitHub, we suggest you first read up on [forking repositories](https://help.github.com/articles/fork-a-repo) and [sending pull requests](https://help.github.com/articles/using-pull-requests), both great articles from the GitHub bootcamp.
2727

28-
Once you've read these — or you've already memorized them — you're ready to contribute to the Telerik UI for Xamarin docs. Start by creating a local clone of our repo either using [GitHub for Windows](http://windows.github.com/), [GitHub for Mac](http://mac.github.com/) or your friendly command-line:
28+
Once you've read these — or you've already memorized them — you're ready to contribute to the Telerik UI for MAUI docs. Start by creating a local clone of our repo either using [GitHub for Windows](http://windows.github.com/), [GitHub for Mac](http://mac.github.com/) or your friendly command-line:
2929

30-
[email protected]:telerik/Xamarin-Forms-docs.git
30+
[email protected]:telerik/maui-docs.git
3131

32-
Then, open up the Xamarin-Forms-docs folder in your favorite text editor and contribute away! Of course, as you work with the docs, we do ask that you follow a couple of ground rules:
32+
Then, open up the maui-docs folder in your favorite text editor and contribute away! Of course, as you work with the docs, we do ask that you follow a couple of ground rules:
3333

34-
- Fixing grammar, punctuation and other general errors is always appreciated. So are changes that expand on key ideas or correct errors in logic phrasing or otherwise. If your ambitions are greater, however, and you want to add completely new content to the site — like a new tutorial on using Xamarin UI with an Atari 2600, for instance — we suggest you contact a member of the team first (or enter an issue!) to vet your idea.
34+
- Fixing grammar, punctuation and other general errors is always appreciated. So are changes that expand on key ideas or correct errors in logic phrasing or otherwise. If your ambitions are greater, however, and you want to add completely new content to the site — we suggest you contact a member of the team first (or enter an issue!) to vet your idea.
3535
- Each document in this repo contains a section of YAML Front Matter at the very top. This content, which looks like the text below, is used by our auto-import tool when content is processed for the live documentation site. Please don't edit the content in this section of a document.
3636

37-
---
37+
38+
---
3839

3940
title: Introduction
4041

@@ -55,21 +56,18 @@ There are two ways you can contribute to the public Telerik UI for Xamarin docum
5556

5657
- When adding content or making changes, please use only standard Markdown syntax, and make to preview your additions or changes before sending us a pull request. You can use an online tool like [Dillinger.io](http://dillinger.io/) or [Marked](http://markedapp.com/) on OSX to view what your changes will look like when ported to HTML.
5758

58-
Once you've made your changes, commit, pull, merge, push and [send us a pull request](https://help.github.com/articles/using-pull-requests)! We — and Xamarin users everywhere — thank you for making our docs the best front-end library documentation on the web!
59+
Once you've made your changes, commit, pull, merge, push and [send us a pull request](https://help.github.com/articles/using-pull-requests)! We — and MAUI users everywhere — thank you for making our docs the best front-end library documentation on the web!
5960

6061
## Running locally
6162

62-
You can generate a static web site from the Telerik UI for Xamarin the documentation and browse it locally.
63+
You can generate a static web site from the Telerik UI for MAUI the documentation and browse it locally.
6364

64-
1. Clone the repository `git clone [email protected]:telerik/Xamarin-Forms-docs.git`
65-
2. Run `bundle install` (you must have ruby and bundler installed beforehand)
66-
3. Run `jekyll serve`
67-
4. Open "http://localhost:4000/devtools/xamarin" in your browser
65+
Detailed instructions on how to achieve this can be found in the [docs-seed repository](https://github.com/telerik/docs-seed#local-setup).
6866

6967

7068
## License
7169

72-
The Telerik UI for Xamarin Documentation is licensed under an MIT license. This license applies to the markdown (.md) files in this site **ONLY**, and does not convey, override or modify any existing licenses covering the runtime source and components of Telerik UI for Xamarin. For information about available licenses for the Telerik UI for Xamarin Cross-Platform click [here](http://www.telerik.com/purchase/license-agreement/ui-for-xamarin-cross-platform), for Telerik UI for Xamarin.Android click [here](http://www.telerik.com/purchase/license-agreement/ui-for-xamarin.android) and for Telerik UI for Xamarin.iOS click [here](http://www.telerik.com/purchase/license-agreement/ui-for-xamarin.ios).
70+
The Telerik UI for MAUI Documentation is licensed under an MIT license. This license applies to the markdown (.md) files in this site **ONLY**, and does not convey, override or modify any existing licenses covering the runtime source and components of Telerik UI for MAUI.
7371

7472
### MIT License
7573

0 commit comments

Comments
 (0)