Redwood: Add missing "documentation" links to vscode outline

Created on 31 Jul 2020  路  3Comments  路  Source: redwoodjs/redwood

This is an easy issue on an interesting part of the codebase.

The feature

  • I added a few documentation links to the outline but I left the job unfinished (on purpose). There are more documentation links to be added.
  • This is what the feature looks like:

Screen Shot 2020-07-30 at 4 11 27 PM

  • The code for the outline is here
  • And here's the interesting bit
  • You should be able to see the pattern and repeat

How to develop and test IDE Features

  • Install the Decoupled Studio VSCode extension
  • Open (in vscode) any Redwood project ( >= 0.15.0 )
  • Confirm that you see the outline and other IDE features
  • This means that the VSCode extension is reaching into the node_modules folder and using the installed redwood framework version for the workspace/app. In other words, VSCode is calling the redwood CLI under the hood (this is not 100% accurate but it gives you an idea)
  • This means that, if you make changes to the redwood framework you're using, you should see the outline change (after refreshing/restarting the VSCode window)
  • In order to edit the redwood framework, you need to follow the local development instructions

Please feel free to comment and improve on these instructions.

good first issue help wanted kinimprovement project-structure

Most helpful comment

Hey @jtoar I'll take a look at the discussion for #935 and also see if I'm capable of working on #912. Thanks for the encouragement. :)

All 3 comments

I would like to try my hand at this since it's tagged as good first issue. This is probably simple since you left it unfinished but I'm not exactly sure what it is I'm suppose to be fixing. I installed the extention, created a new RW project, opened up VSCode but I do not see any of those icons.

Hey @awey95 glad you're excited to start contributing! :rocket: There's actually a PR (#935) aiming to close this one out. You're more than welcome to get in touch with @forresthayes over there. Every PR always has a ton of discussion around it, and adding to the discussion around a PR _is_ contributing!

But if you're looking to champion an approachable issue, might I suggest https://github.com/redwoodjs/redwood/issues/912? You'd get to dive into the toml file, which is much more the hub of a Redwood app than it looks on the surface.

And if anything else looks interesting to you, good first issue or not, we're all ready to help and make it as approachable as possible!

Hey @jtoar I'll take a look at the discussion for #935 and also see if I'm capable of working on #912. Thanks for the encouragement. :)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

CR1AT0RS picture CR1AT0RS  路  4Comments

wispyco picture wispyco  路  3Comments

hemildesai picture hemildesai  路  4Comments

tmeasday picture tmeasday  路  4Comments

weaversam8 picture weaversam8  路  4Comments