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

Docs: move Fields to own pages #22

Open
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

privatemaker
Copy link
Collaborator

@privatemaker privatemaker commented Feb 9, 2024

First pass attempt at #10 i'm not sure if what I did will satisfy Gatsby, but pushing trigger a build and investigate. This is a WIP

Copy link

netlify bot commented Feb 9, 2024

Deploy Preview for decap-www ready!

Name Link
🔨 Latest commit c5b1c0d
🔍 Latest deploy log https://app.netlify.com/sites/decap-www/deploys/66c58d1723f76c0008290361
😎 Deploy Preview https://deploy-preview-22--decap-www.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@martinjagodic
Copy link
Member

martinjagodic commented Feb 12, 2024

I am a bit concerned about the length of the sidebar at this point. Maybe I should look into collapsing them?

I am also not sure that we are removing the name Widgets from the docs. I think these should be still called widgets because a Field and a Widget are different concepts.

What about joining them into a subsection like this?

├ Fields
│ └- Widgets
│    ├-- String
│    └-- Text

@privatemaker
Copy link
Collaborator Author

privatemaker commented Feb 14, 2024

I am a bit concerned about the length of the sidebar at this point.

Yeah, I do get that concern. Perhaps collapsibles are needed now. I think it would honestly be an improvement in general..

I think these should be still called widgets

Yeah, I agree. I'll make that change.

@privatemaker
Copy link
Collaborator Author

privatemaker commented Feb 14, 2024

I'm not happy with how this is looking at all. I think we should try to keep the buttons of the all the widgets in a list like it currently is:

But refactor it so each widget is a first class page such as Image as opposed to an AJAXy box that is visually constrained.

  • Make the main level of details no longer a <ul> list, as it currently is:

With proposed change they are left aligned with normal page text. While the items under Options are the first level <ul> I think this will make things more readable.

The image widget allows editors to upload... 

Name: image
UI: file picker...
Data types: file path string
Options:
 - default: accepts a file path string; defaults to null
  • Include a screenshot of each rendered UI widget would be nice.

@martinjagodic
Copy link
Member

I agree with all your points.

Navigation: I think we need to put side menu items into accordions. That way other widget links will be visible all the time and we don't need the buttons.

I agree with both of your other points.

I can help with the sidebar and/or screenshots but I have some other tasks that I need to finish first, so it might take some patience.

@privatemaker privatemaker force-pushed the docs/make-fields-pages branch from a608b23 to b74884a Compare February 15, 2024 11:01
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

Successfully merging this pull request may close these issues.

2 participants