feat: add initial content
- update getting started guide - update about the website reference
This commit is contained in:
parent
70ec3800ba
commit
ce7080222c
3 changed files with 30 additions and 16 deletions
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
title: Get Started
|
||||
description: A guide in my new Starlight docs site.
|
||||
---
|
||||
|
||||
Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
|
||||
Writing a good guide requires thinking about what your users are trying to do.
|
||||
|
||||
## Further reading
|
||||
|
||||
- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
|
22
src/content/docs/guides/getting-started.md
Normal file
22
src/content/docs/guides/getting-started.md
Normal file
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
title: Getting Started
|
||||
description: A guide on how to start use the Pragmatic Guides website
|
||||
---
|
||||
|
||||
Hi! Welcome to the Pragmatic Guides!
|
||||
|
||||
Regardless of how you found the website, this page should be a good starting place.
|
||||
|
||||
## Read about the website
|
||||
|
||||
I recommend going through my short [reference page about the website] first to understand the purpose of the whole place and who I am (the author).
|
||||
|
||||
## Finding topics
|
||||
|
||||
To find specific topics with key words, you can use the search bar at the top of the website.
|
||||
|
||||
There is a menu if you want to browse the guides and reference pages available.
|
||||
|
||||
## Giving feedback
|
||||
|
||||
You may send me your feedback via [email](mailto:ayo@ayco.io), [Mastodon](https://social.ayco.io/@ayo), or any of my [contact channels](https://ayo.ayco.io/about#contact).
|
|
@ -1,11 +1,14 @@
|
|||
---
|
||||
title: About the website
|
||||
description: A reference page in my new Starlight docs site.
|
||||
description: A brief reference describing the purpose of the Pragmatic Guides website
|
||||
---
|
||||
|
||||
Reference pages are ideal for outlining how things work in terse and clear terms.
|
||||
Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
|
||||
Hi!
|
||||
|
||||
## Further reading
|
||||
In this website, [Pragmatic Guides](https://guides.ayos.blog), are a collection of small guides on how to build experiences using Web technologies (HTML, JS, CSS) and different developer tooling.
|
||||
|
||||
- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework
|
||||
[I](https://ayo.ayco.io/about) started this to be a home for various documentations I write as a result my [hobby projects](https://ayo.ayco.io/showcase).
|
||||
|
||||
I am open to feedback, questions, and/or requests for new guides.
|
||||
|
||||
Please [send me a mail](mailto:ayo@ayco.io), [tag/follow me on Mastodon](https://social.ayco.io/@ayo) or reach me via any of my [contact channels](https://ayo.ayco.io/about#contact).
|
Loading…
Reference in a new issue