Community Feedback Needed - new wix code reference

[yoav-wix]

Hay Wix Code community,

We are working on creating a new format for the wix reference site (the API documentation). we have a version that is kind of done and like to hear feedback on.

The version is at
https://www.wix.com/wix-code-reference-viewer

Any feedback, ideas, mistakes, missing examples - all kind of feedback is welcome.

Do note that the cheatsheet and glossary pages are still in the works.

[nicolasgpo]

A little bit of color would not hurt to increase contrast, really like the left side menu panel; I think a more hierarchical layout of the information might be useful to users of all levels.

[abergquist]

I appreciate you guys doing this.

In addition to what NicolasGPO mentioned, one thing I’ve wanted since I first encountered Wix was the ability to easily print out the entire API so that I could have it as a hardcopy reference in addition to the online one.

[felipe-bustos]

Thank you @yoav-wix . Here’s what I see:

• Pros: tried looking for one but couldn’t find it… what makes it better from the current one?

• Cons:

1. I don’t like the word “hate”… but I hate the serif font… what happened to the good old Helvetica Neue sans-serif?
2. Font size could be bigger.
3. Maybe some issues with the rendering of the page? see image attached from Chrome.

4. When looking at a specific function the origin API breadcrumb link doesn’t work. Example: wix-users > logout() clicking wix-users doesn’t do anything.
5. I’m already used to the current API documentation and the way it is styled…

[roberthamilton]

Okay, i love change. However, i am a little confused. I am finding it hard to see any major changes.

Pros: Navigation on the left is better (more prominent).

Cons: The design is bad + It looks busier and is hard to follow (for me) + font is a bit too small, needs to go 1/2px up in size.

[salman-hammed]

Awesome Thanks for updating
As already suggested about the fonts, color and size
Two things
#Color Combo
Use the same color in the wix code IDE

#Cheatsheet
I like the print button in the new cheatsheet
Please leave the old cheatsheet, if possible
Only thing we need in the old sheet is the print button
The group color, bold letter and link in the old cheatsheet are perfect to find

Search bar , Glossary, Example code on the right side nailed it!!

[stcroppe]

Hi Yoav:

These comments are based using Safari on iPadPro iOS12.

Theming :
As mentioned above. Different people have different requirements for color and contrast of content on their web page. Some of these are preference based others may be medical (e.g. color blindness). Perhaps offering themes for the RHS and LHS columns would be something to consider.

MDN Links :
MDN Links don’t seem to work (e.g. Type string or Date etc.).

Section footer :
On my iPad the bottom of the API section does not scroll into view obscuring some content

- YouTube

Reference Links :

I am not a fan of being taken to a new page for a link that is a reference to text that I am reading. Is it possible to load a light box containing the reference text with an option to load a new page?

- YouTube

Continuous Scroll :
Is it possible to load the next code section when you scroll to the end of the current section instead of forcing a new ‘click’ on the RHS Menu. So as an example when you scroll to the end of the wix-fetch API section (see Section Footer above) the api section loads the information for WixFetchResponse .

Steve

[code-queen]

You know I love you guys, right? Ok, good. So here goes my opinions …

Font is too small for me, it hurts my eyes because I have squint my eyes to read it.
I prefer long scrolling design vs ‘side by side’.

I really love this black design for the code examples (I just don’t like the way it is displayed next the descriptions. I actually prefer the 'wix answer’s style where it has anchor menu, related & long scrolling design.) . The white section could use more color (more ‘Wix’ color/style/design) because it makes it more difficult to read & understand words/data.

There is a lot of wasted space making it look unbalanced / not efficient.

[yoav-wix]

Hay all,

Thanks for the feedback. We will definitely try a larger font size, redo the cheatsheet and will take into account your other comments as well. This version is not done, as in 100% done. It is about 95% done, we prefer to share early to be able to fix and adjust based on your feedback.

Why are we doing this change? It is part of two programs that happen in parallel for us.

The first, is focused internally on the process of API design, building and documenting. We have today about 15 different teams contributing to APIs, and we need a modular system for that. This new site is based on this modular system, while the old reference is all or nothing type of system. With the new API reference, we hope to be able to roll out more APIs and faster.

The second, is to be able to iterate faster on the documentation site itself. We are planning to add to the left navigation tree also the examples, tutorials, guides (which are now on answers) as well as other stuff.

Keep posted for another version in the coming days…

BTW, the new API site has two new APIs published - the video player API and the wix stores getProductOptionsAvailability function available on the wix-stores module in addition to the wix-stores-backend module.

[abergquist]

“OPERATIONS” should be replaced with either “METHODS” or “OPERATIONS/METHODS” or “METHODS/OPERATIONS”.