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.

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

Write/Update Wiki Docs #608

Open
8 tasks
jennparker opened this issue May 15, 2017 · 17 comments
Open
8 tasks

Write/Update Wiki Docs #608

jennparker opened this issue May 15, 2017 · 17 comments

Comments

@jennparker
Copy link

jennparker commented May 15, 2017

Let's use this issue to consolidate and track docs that need to be written or updated. Note: Docs that need to be moved to or within the wiki are being tracked in a separate issue. This issue is only for adding or making changes to content. Please help add to this list.

Write
These are new documents that we need to have written:

Tutorials
These should be added as separate wiki pages and should be added to Tutorials and Guides

  • Websites containing pages of different heights
    Easy rearranging of content - move sections up/down with keyboard arrow keys

General Documentation

Update
These are existing documents that need to be updated:

@David1platt
Copy link

I'll get started on this next week. I'm heading into finals starting tomorrow... Is there a repository of GIFs and graphics to be used with these docs?

@singchan
Copy link

Great!
There is no repo of media, they are all in the posts and on youtube

@David1platt
Copy link

Hey Singchan thanks for the feedback. The documentation maintenance is pretty casual. I totally revamped the Getting Started page, and the Dashboard section while that was a separate page. I don't feel like I've been properly introduced to the team.

@singchan
Copy link

you can introduce yourself in a new issue maybe?

@singchan
Copy link

and you can add your name, like @jeff3211 did

also the page looks great, somone should try to follow the turorial now :)

@jennparker
Copy link
Author

That's awesome, @David1platt, thanks! All, sorry that I haven't been able to contribute much lately. I've started a short term contract position that has kept me very busy. As part of a writing sample submitted for a recent interview, I revamped the Silex README.md. I have put it in a new page in the wiki temporarily so you can review it. I cut some bits of the current README out, so I'm not sure if it 100% usable in its current form. I'd love some feedback/contribution help if there is anything else that should be in the document. For example, I cut out the Hosting your own instance part (mainly because I wasn't completely sure on all of the steps to do so). I think it might be a good topic to move to a wiki page anyway. Thoughts?

@singchan
Copy link

it looks good to me

@David1platt
Copy link

@jennparker The readme is well written, and free of grammar issues. Nice work!

@David1platt
Copy link

David1platt commented Jun 26, 2017

Hey folks I updated the UI Main Menu section of the of the Editor UI page. The context menu has completely changed. Should I just describe the functionality of the menu at the top of the editor window? I also updated the guide for working with the live map component - here. Any feedback would be greatly appreciated.

@lexoyo
Copy link
Member

lexoyo commented Jun 27, 2017

Hi @David1platt

Hey folks I updated the UI Main Menu section of the of the Editor UI page.

Nice work! Looks very good to me
Maybe you should make the list of components (Utils) link to the components pages? And the "code menu" and "Pages" and "Settings" have their doc section too I think

The context menu has completely changed. Should I just describe the functionality of the menu at the top of the editor window?

Yes you are right it changed completely a while ago.. So yes sure 👍

I also updated the guide for working with the live map component - here. Any feedback would be greatly appreciated.

Here are small changes I made, feel free to revert them and take the ones you like

I like what you did with it!

@David1platt
Copy link

context-menu

new context menu screenshot, updating Editor Ui section

@David1platt
Copy link

properties screen shots -

position-size

alt-tooltip

link

visible-on

opacity

background-colo

background-image

visible-on

styles

@lexoyo
Copy link
Member

lexoyo commented Jan 7, 2018

@David1platt nice!
Did you put them in the wiki somewhere already?

@lexoyo
Copy link
Member

lexoyo commented Jan 7, 2018

Websites containing pages of different heights
Easy rearranging of content - move sections up/down with keyboard arrow keys

this is actually a good idea
if someone is ready to write we can chat about it, I can explain how to do it

@David1platt
Copy link

David1platt commented Jan 8, 2018

@lexoyo I haven't put the images in the wiki yet. I wanted to be careful with how images work with the text. Sorry I haven't worked on documentation in a while.

@lexoyo
Copy link
Member

lexoyo commented Mar 19, 2018

Hi
I updated the issue #238 to redirect people to the more recent content in the wiki here
Screenshots are still old though

@lexoyo
Copy link
Member

lexoyo commented Apr 5, 2020

Hi
I guess this task is done, what do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants