Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documented configuration options #97

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

documented configuration options #97

wants to merge 3 commits into from

Conversation

FND
Copy link
Contributor

@FND FND commented Mar 22, 2019

this format isn't great for anyone: cumbersome to author/edit, hard to read - however, it does allow for scanning, which would be harder with simple lists

  • merge examples into description column
  • add meta-package requirements to corresponding options
  • mention file extensions being added automatically (i.e. .jsx, .ts)
  • sort by significance (e.g. extensions generally shouldn't be needed)
  • add explanatory sections (e.g. externals, export, compact)
  • switch to AsciiDoc because tables
  • decide where to publish these docs (website?)

@FND FND force-pushed the docs branch 3 times, most recently from 2b1e9d5 to a18406d Compare March 22, 2019 15:11
@FND FND force-pushed the docs branch 2 times, most recently from 40dd2da to b231228 Compare May 10, 2019 08:12
apart from `extensions` (which should rarely be necessary), this seems
pretty arbitrary though
@FND FND force-pushed the master branch 4 times, most recently from 3e9a3cd to a4b1278 Compare January 8, 2020 06:48
@moonglum moonglum changed the base branch from master to main March 8, 2022 07:43
@moonglum
Copy link
Member

My proposal is to add the outlined documentation to the website. Added to this PR: faucet-pipeline/docs#62

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants