question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Update Github Wiki or move it to Docs?

See original GitHub issue

Hey all,

So I believe the github wiki is the first main source of info for new developers to the repo. As far as I’m aware, only collaborators can update it. It may be an idea to create a new section in the docs instead of using the github wiki. Perhaps putting contributors under the Code section of the main page.

As well as migrating the github wiki, I can think of an addition that might make various peoples lives easier, a “common issues” page (think issue posted, instant close, link to part of common issues). There are also some random pages which could be removed i.e. API reference. Those are two bits and pieces that come to mind but I’m sure others have more ideas.

It may help sort out miss-communication, speed up reviews and/or ease the barrier to entry.

I’d be happy to flesh out a first draft but I ain’t starting that until I’ve got the proper feedback.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:26 (18 by maintainers)

github_iconTop GitHub Comments

3reactions
Mugen87commented, Apr 13, 2020

I’ve always had the impression that “npm run start” is pretty close to the “standard” name for this task. Maybe we should suggest that instead of dev?

You can actually use just npm start which I would prefer instead of npm run dev. Besides,npm run test should be npm test.

3reactions
looeeecommented, Apr 12, 2020

Maybe we could link to the wiki from the docs?

For example, we could add a “how to contribute to three.js” manual page that tells people to check out the wiki for more info.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Adding or editing wiki pages - GitHub Docs
On GitHub.com, navigate to the main page of the repository. · Under your repository name, click Wiki. · In the upper-right corner of...
Read more >
Editing wiki content - GitHub Docs
Adding images · On GitHub.com, navigate to the main page of the repository. · Under your repository name, click Wiki. · Using the...
Read more >
[project management] Move wiki to docs repo #4196 - GitHub
In the wiki sidebar, reference their github location. 1.2 Move remaining wiki pages to netdata/docs and update the wiki sidebar.
Read more >
Adding or editing wiki pages - GitHub Enterprise Server 3.3 ...
You can add and edit wiki pages directly on GitHub Enterprise Server or locally using the command line.
Read more >
About wikis - GitHub Docs
A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information,...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found