Frequently Asked Questions (FAQ)
Welcome to Capstones Frequently Asked Questions (FAQ) section! We understand that you might have queries about contributing in your Capstone repo 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.
Where can I find the link to Your Company goes here GitHub channel
Find link here.
Which Your Company repository should I clone to contribute to the Documentation Website
To contribute to the Documentation Website, locate the “Your-Company-Documentation-Website” repository, navigate to the src/content/docs, and upload your .md or .mdx file to the relevant folder.
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?
Re-install or upgrade the version of Node.js software on your laptop.
How do I make a newly created folder to appear on the side navbar of the Documentation website?
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 wheel, 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.
Is there a video that helps me understand how to migrate documents to the Documentation website?
Yes, there is. Find some helpful links below created by the Company Company.
What do I do to resolve Linelint issues in the CI build checks for my Pull Request?
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.
What do I do to resolve Prettier issues in the CI build checks for my Pull Request?
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.
My Pull request keeps failing the netlify checks
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