Blog

platformOS Documentation and UX Status Report — May 27, 2019

UPDATES
STATUS REPORT
DOCUMENTATION
UX
Participate in our research to reorganize the Tutorials section and see the results of the research for renaming marketplace-kit and marketplace-builder.
platformOS Documentation and UX Status Report — May 27, 2019

Call for Contribution: Tutorials Reorganization

We now have 136+ topics in our tutorial section organized into 27 groups, and we’re planning to add more. As many of you also pointed out, we could improve the usability of the Tutorials section with a better organization of the topics. Please participate in our research to help us find the structure that best fits your needs.



How to participate?

If you are using our Tutorials on the Documentation site, you are a perfect candidate to take part in this approx. 10 min card sorting exercise. Click on the link below, and follow the instructions on screen (no registration required):

Start Tutorials Reorganization Exercise



Documentation

Content production

  • UPDATED Sharing a Module - made module zip creation clearer
  • IN REVIEW Using the GeoJSON format for Geolocation
  • PLANNED Cheat sheet for platformOS Liquid tags and filters
  • PLANNED updates to Creating SEO-Friendly URLs
  • PLANNED updates to Custom Addresses
  • PLANNED updates to platformOS Liquid filter "url_for_path_with_token"

Improvements, fixes

  • Fixed contributor and date display issue on topics


UX

Research

  • RESULTS Thank you for your contributions to the naming research with the goal to collect your opinion about how you would rename marketplace-kit and marketplace_builder.
    21 participants shared their thoughts and in some cases, they provided more than one answer.
    Related to the renaming of marketplace-kit you found it important that the new name should refer to the brand, explain what it is, make it simple and quick to type. Results in order: 1. pos     2. pos-cli    3. pos-kit
    You imagined that the new name of the `marketplace_builder` should follow how other frameworks name their structure. It should also be intuitive and quick to type.  Results in order: 1.  app   2. pos-instance  3. instance / pos-build
    You also suggested renaming other folder elements. Read more about the results
    Decision and implementation are coming as a next step. We will keep you in the loop!


Design and Development

The team is continuously focusing on the Module Marketplace and updating the features:

  • NEW Removed template from Description, documentation, and support field.
  • NEW Module accessibility was hidden and will be reintroduced after the feature refactor.
  • NEW Statements for sellers
  • IN PROGRESS Define the module tags

Let us know if you experience anything we need to know about!

Interested in knowing more about partnering with platformOS?

Ensure your project’s success with the power of platformOS.