Skip to content

Commit

Permalink
Merge pull request #23 from thoth-tech/Help-Hub-branch
Browse files Browse the repository at this point in the history
Added FAQ page and content to the doc website
  • Loading branch information
Kachi-Okorie committed Dec 4, 2023
2 parents c59f211 + 9dc8c75 commit 72aaf1a
Show file tree
Hide file tree
Showing 4 changed files with 87 additions and 48 deletions.
16 changes: 0 additions & 16 deletions src/content/docs/FAQ.md

This file was deleted.

34 changes: 14 additions & 20 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ hero:
link: /products/products/
icon: right-arrow
variant: primary
- text: How to Use Starlight
link: https://deakin365.sharepoint.com/:v:/r/sites/ThothTech2/Shared%20Documents/General/Instructional%20Video%20-%20How%20To%20Upload%20Documents%20to%20Starlight.mp4?csf=1&web=1&e=s26lMo
- text: FAQ
link: /reference/faq/
icon: right-arrow
variant: primary
---
Expand All @@ -20,19 +20,17 @@ import { Card, LinkCard, CardGrid } from "@astrojs/starlight/components";
## About Us:

<Card title="What we do">
Thoth tech creates tools that enhance education outcomes by empowering
students, connecting them with tutors and facilitating personalised learning
experiences. Values Our values describe how we work, what we represent, and
guide us to be the kind of company and team members we want to be. When we
live up to these values we will: Be people-focused We expect the best from
each other, give each other the benefit of the doubt, encourage each other to
take initiative to improve ourselves and the company, and provide direct and
constructive help to each other. We collaborate with kindness while being
respectful of each other. Uphold sustainable excellence We create working,
maintainable, and understandable software that is enjoyable and easy to use. 8
We strive to do it in a way that is sustainable for our team members and for
our environment. Be inclusive and supportive We celebrate diverse perspectives
and embrace uncomfortable ideas and conversations.
Thoth tech creates tools that enhance education outcomes by empowering students, connecting them
with tutors and facilitating personalised learning experiences. Values Our values describe how we
work, what we represent, and guide us to be the kind of company and team members we want to be.
When we live up to these values we will: Be people-focused We expect the best from each other,
give each other the benefit of the doubt, encourage each other to take initiative to improve
ourselves and the company, and provide direct and constructive help to each other. We collaborate
with kindness while being respectful of each other. Uphold sustainable excellence We create
working, maintainable, and understandable software that is enjoyable and easy to use. 8 We strive
to do it in a way that is sustainable for our team members and for our environment. Be inclusive
and supportive We celebrate diverse perspectives and embrace uncomfortable ideas and
conversations.
</Card>

<CardGrid>
Expand All @@ -46,11 +44,7 @@ import { Card, LinkCard, CardGrid } from "@astrojs/starlight/components";
description="Learn how Thoth Tech functions."
href="/processes/introduction/"
/>
<LinkCard
title="News"
description="View the latest in Thoth Tech news."
href="/blog/"
/>
<LinkCard title="News" description="View the latest in Thoth Tech news." href="/blog/" />
<LinkCard
title="Leadership"
description="Meet our team."
Expand Down
12 changes: 0 additions & 12 deletions src/content/docs/reference/example.md

This file was deleted.

73 changes: 73 additions & 0 deletions src/content/docs/reference/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
title: Frequently Asked Questions (FAQ)
description: Frequently Asked Questions
---

Welcome to Thoth Techs Frequently Asked Questions (FAQ) section! We understand that you might have
queries about contributing in Thoth Tech or seek clarification on how to use certain tools. Our aim
is to provide you with comprehensive and straightforward answers to address your concerns promptly.

<details>
<summary>Where can I find the link to Thoth Tech GitHub channel</summary>

Find link [here](https://github.com/thoth-tech/).
</details>

<details>
<summary>Which Thoth Tech repository should I clone to contribute to the Documentation Website</summary>

To contribute to the Documentation Website, locate the ["Thothtech-Documentation-Website" repository](https://github.com/thoth-tech/ThothTech-Documentation-Website/tree/main),
navigate to the src/content/docs, and upload your .md or .mdx file to the relevant folder.
</details>

<details>
<summary>When I attempt to run the documentation website locally, it says "The .nvmrc file is using a
version of node that is not supported by astro anymore". Please how do I fix this?</summary>

Re-install or upgrade the version of Node.js software on your laptop.
</details>

<details>
<summary>How do I make a newly created folder to appear on the side navbar of the Documentation website?</summary>

On the astro.config.mjs file, create a new label (if main folder) or item(if sub folder). You do not
need to reinvent the will, you can copy from what already exists on the astro.config.mjs file, insert
the copied block into the right location, and modify the labels and directory link.
</details>

<details>
<summary>Is there a video that helps me understand how to migrate documents to the Documentation website?</summary>

Yes, there is. Find some helpful links below.
- [Instructional video](https://deakin365.sharepoint.com/:v:/r/sites/ThothTech2/Shared%20Documents/General/Instructional%20Video%20-%20How%20To%20Upload%20Documents%20to%20Starlight.mp4?csf=1&web=1&e=s26lMo).
- [Help hub session recording](https://deakin365-my.sharepoint.com/:v:/g/personal/s221460489_deakin_edu_au/EXib27xJI2hCkHpzBXOxxYQBOfDGhhQJ1A23ciisMROeRA?xsdata=MDV8MDF8fDgxMTZlNDYzMzAyZTQxYTZhNGE2MDhkYmYyMWMwMGY1fGQwMjM3OGVjMTY4ODQ2ZDU4NTQwMWMyOGI1ZjQ3MGY2fDB8MHw2MzgzNjk5NzQyOTIxNjE3MDJ8VW5rbm93bnxWR1ZoYlhOVFpXTjFjbWwwZVZObGNuWnBZMlY4ZXlKV0lqb2lNQzR3TGpBd01EQWlMQ0pRSWpvaVYybHVNeklpTENKQlRpSTZJazkwYUdWeUlpd2lWMVFpT2pFeGZRPT18MXxMM1JsWVcxekx6RTVPbEZtZUY5VFZFaFZPVEJQYzFaWlFraFdXVXRvYzFKUk5XZHRSV1V3Y3psUk5tdFBjRUptTm1Kc2FUZ3hRSFJvY21WaFpDNTBZV04yTWk5amFHRnVibVZzY3k4eE9UcFJabmhmVTFSSVZUa3dUM05XV1VKSVZsbExhSE5TVVRWbmJVVmxNSE01VVRaclQzQkNaalppYkdrNE1VQjBhSEpsWVdRdWRHRmpkakl2YldWemMyRm5aWE12TVRjd01UUXdNRFl5T0RNd01nPT18NTg0ZjIwNWZmZjA3NGZlZTQyNjQwOGRiZjIxYzAwZjN8ZTU2N2Y4NzA4YjFlNDI1YWIzYjRhM2I1NmExY2QwMjE%3D&sdata=TldtNGVnTDJWWlVnb2lBMGlZZXlLNEI1M2p5emU3ZndBYmpSTkV6MnN0QT0%3D)
</details>

<details>
<summary>What do I do to resolve Linelint issues in the CI build checks for my Pull Request?</summary>

Identify the file which has the lint issue from the details section of the CI Build check. Open the
identified file on Visual Studio code or your editor of choice, right click on the document and select
Format document with markdownlint. Ensure that you have the markdownlint extension installed on your
code editor.
</details>

<details>
<summary>What do I do to resolve Prettier issues in the CI build checks for my Pull Request?</summary>

Identify the file which has the prettier issue from the details section of the CI Build check. Open
the identified file on Visual Studio code or your editor of choice, right click on the document and
select Format document with Prettier. Ensure that you have the Prettier extension installed on your
code editor.
</details>

<details>
<summary>My Pull request keeps failing the netlify checks</summary>

In such instances, the primary reason is often due to the absence of a title block at the start of your markdown file.
For example.
```
title: Frequently Asked Questions (FAQ)
description: Frequently Asked Questions
```
</details>

0 comments on commit 72aaf1a

Please sign in to comment.