Wiki page

[ntvthuyen]

I've created a wiki page for sandbox-website. This is simply wiki page that allows people to write documents using markdown.
The page currently can be used now, however, there some features I do not add right now, like: searching. I'll work on it as soon as possible.
I know there some limitations, but I'm gonna change it in the future.
The guide to use is written as a document on the wiki page you can check it out.

Let me know if there was something wrong this is my very first time I've made a pull request to an open source project!

[mmayernick]

Should exclude/ignore system files (eg .DS_Store)

Also, to clarify, I'm assuming there is no front end to this, is that correct? Will users have to push markdown files to the repo to update? Just trying to understand the workflow. Thanks!

[ntvthuyen]

Thanks for replying to me, I will care about system files next time.
And also, yes, users have to push markdown files to repo to update.
Do you think we can do better?

[mmayernick]

No, I think that's a limitation of the current setup (static hosted on github), was just checking. Thanks!

[actuallymentor]

Thank you for your PR! Welcome to the Sandbox geek squad :)

Some notes before we can merge:

• Please abstract your js code into a separate file and import it into the 'main.js(like you did with yourdocs` module
• Please refactor your code to include consistent indentation and comments (specifically in the main.js)
• Your interface includes a nonfunctional search bar, please comment it out if it does not work yet
• If you are up for it, do a local demo of this with a few members to work out some design kinks, there are some little things like padding in the mobile menu (see screenshot)

[ntvthuyen]

Thank you for replying to me. I think I will ask my friend who has experience in web development to help me that.

[ntvthuyen]

I've updated it, please have a look!

[actuallymentor]

Thanks for the update @lightkeima!

It seems you have forgotten some of the points I mentioned, in particular:

• Please abstract your js code into a separate file and import it into the main.js (like you did with your docs module
• Please refactor your code to include consistent indentation and comments (specifically in the main.js)
• Your interface includes a nonfunctional search bar, please comment it out if it does not work yet
• If you are up for it, do a local demo of this with a few members to work out some design kinks, there are some little things like padding in the mobile menu (see screenshot)
  • Optionally ask some local members for some initial content. Currently the wiki is empty, which is a good start, but if there is no group taking initiative then it is likely to remain empty.

[ntvthuyen]

Thanks for your feedback
Can you tell me which part that I've written in main.js I should separate? In this update, I've moved the parse function and some code into another folder named /markdown inside /js folder; however, I forgot to add comments :(. And here are some screenshots, tell me if you want me to change something.

[actuallymentor]

Can you tell me which part that I've written in main.js I should separate?

See line 56 and onward

Let me know if the other points require clarification :)

[actuallymentor]

For a good guide, have a look at the most recent main.js here in the master branch.

I recommend running a rebase so you have the latest code :)