nylas/nylas-mail

Improve and update documentation

Open

#2,048 opened on Apr 24, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (1,370 forks)batch import
enhancement-requestgood-starter-issuehacktoberfesthelp-wanted

Repository metrics

Stars
 (24,786 stars)
PR merge metrics
 (Avg merge 3h 15m) (1 merged PR in 30d)

Description

I could be missing something here, but it looks like the documentation is missing a few things

When following the getting started guide it talks about .cjsx files, where as the client creates .jsx. The code in the created files is different from the guide.

The next thing is that a number of areas seem to create a link loop.

  • On the getting started guide, select "head over to our full documentation".
  • This takes you to a documentation menu page
  • Select API. This then takes you to the Nylas home page.

I have a couple questions also. I assume this is not the best place to ask though, so the first question is, where is the best place to discuss and ask questions? Is there a forum? Is there any updated documentation? I am looking at a way to hide messages in a particular folder, based on parameters i set, through a plugin. Is this possible?

Contributor guide

Research direction
Review the getting started guide to fix the .cjsx vs .jsx file extension discrepancy, update code examples to match the client, and fix link loops (e.g., the 'full documentation' link that leads to Nylas homepage).
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90