Skip to content

Commit

Permalink
Initial Frequently Asked Questions (FAQs) page that is a child to the…
Browse files Browse the repository at this point in the history
… Documentation page and cross-linked accordingly. Corresponds to issue selfdefined#246
  • Loading branch information
mannybecerra committed Aug 29, 2020
1 parent 4ce8bf2 commit b55ec86
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
25 changes: 25 additions & 0 deletions 11ty/documentation/frequently-asked-questions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: FAQs
parent:
title: Documentation
href: '/documentation'
---

Answers to frequently asked questions.

## When should I open an issue versus a pull request (PR)?

### Open PR

* Correct misspellings
* Fix broken links
* Add definitions/nuance/translations to words that exist on the site already but are undefined/partially defined/could use more nuance
* Resolve issues that already exist

### Open Issue

* Concern or question around a term that you don't have clear prescriptive feedback around
* Adding a new term that is not yet listed (with or without definition)
* Adding/enhancing a feature that you're unsure is desired

**Related:** [Contributing Guidelines](//github.com/selfdefined/web-app/blob/prod/CONTRIBUTING.md)
1 change: 1 addition & 0 deletions 11ty/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ title: Docs
As always, documentation is a work in progress. However, this is what we have so far:

- [Examples](/documentation/examples/): Grab-and-go definition examples
- [FAQs](/documentation/frequently-asked-questions): Answers to frequently asked questions
- [Front Matter](/documentation/front-matter/): Configuration possibilities through front matter
- [Development & Build](/documentation/development/): Notes for developing the site

0 comments on commit b55ec86

Please sign in to comment.