add documentation for how to create a FAQ #546
Conversation
|
@haroon10725 looks good, thanks. |
|
|
||
| 2. **Create a New Markdown File:** | ||
| * Create a new file in the _faqs folder. |
There was a problem hiding this comment.
You should also indicate that you must append with .md.
As for prepending with Q1, Q2, Q3, I'm unsure if we really want to keep them numbered as they are now. We may need to shuffle the order later. We should think more about that.
There was a problem hiding this comment.
For example, we may want to organize by topic, if these files can include multiple questions.
There was a problem hiding this comment.
@pikurasa I think we can remove them, as we are not rendering these numbers to display on website. The numbers that are being rendered are coming from ordered list "ol" in FAQ.html.
|
|
||
| 4. **Save and Preview:** | ||
| * Save the file, then run `jekyll serve` in your terminal to start the local server. Visit `http://localhost:4000` to preview your FAQ. |
There was a problem hiding this comment.
I think we want to point to the instructions in the README file that indicate how to run and test a server.: https://github.com/sugarlabs/www?tab=readme-ov-file#running
That way, if our instructions change, we don't need to change them in two places.
What we may want to do, however, is update the "Running" section to indicate that jekyll serve (without incremental" is a good way to force new post pages in FAQ, blog, news, and events to build.
There was a problem hiding this comment.
Then i think, we should change our README file also. As there is no command of "jekyll serve" mentioned in it.
There was a problem hiding this comment.
You can add to our readme something to the effect of:
jekyll serve: Rebuilds the entire website from scratch each time.
bundle exec jekyll serve --incremental: Only regenerates changed files since the last build, making development faster and more efficient but does not render posts (i.e. FAQ, blog, news, and events).
@pikurasa Can you please review it.