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.

Sign up for GitHub

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

Jump to bottom

Documentation Improvements #52

Closed
8 of 13 tasks
joelgallant opened this issue Dec 6, 2020 · 2 comments
Closed
8 of 13 tasks

Documentation Improvements #52

joelgallant opened this issue Dec 6, 2020 · 2 comments
Assignees
@joelgallant
Labels
documentation For website and other forms of documentation help wanted Extra attention is needed

Comments

@joelgallant
Copy link
Contributor

joelgallant commented Dec 6, 2020 •
edited
Loading

  • Better explanation of the "deepness" of parsing extensions and where they can be used
  • Meta tags and descriptions for SEO
  • FAQ section
  • Write more about other languages
  • Explicit mentions for language support
  • Provide official instructions for jest support (eg. module resolve rules, mocking)
  • More documentation about Cypress plugin
  • Write about ghcr.io/launchcodedev/app-config docker image
  • More review of fields and options available to users
    • Clean up "API Reference" page
  • Review every page for any features missing
  • More documentation about Vault plugin
  • Write more comparison to .env files (and how to generate them)

Look at other ecosystem libraries to find any comparisons or ways to explain concepts:
@joelgallant joelgallant added help wanted Extra attention is needed documentation For website and other forms of documentation labels Dec 6, 2020
@joelgallant joelgallant added this to the Version 2 milestone Dec 6, 2020
@joelgallant joelgallant self-assigned this Dec 6, 2020
@joelgallant joelgallant changed the title Finishing Documentation Polishing Documentation Dec 19, 2020
@joelgallant joelgallant removed this from the Version 2 milestone Dec 19, 2020
@joelgallant
Copy link
Contributor Author

@daniel-zarinski @gregnr looking for any help I can get on this - having one voice is nice but I have blinds spots in how things should be covered. maybe you could throw it at a junior, if possible?

@joelgallant joelgallant added this to the Version 2.1 milestone Feb 7, 2021
@joelgallant joelgallant changed the title Polishing Documentation v2 Documentation Polish Feb 13, 2021
@joelgallant joelgallant removed this from the Version 2.1 milestone Mar 18, 2021
@joelgallant joelgallant changed the title v2 Documentation Polish Documentation Improvements Apr 16, 2021
@joelgallant
Copy link
Contributor Author

Moving to #137 #138 #139 #140 #141 etc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@joelgallant joelgallant

Labels
documentation For website and other forms of documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@joelgallant