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

Add missing plugin overviews #552

Merged
merged 23 commits into from
Apr 4, 2023
Merged

Add missing plugin overviews #552

merged 23 commits into from
Apr 4, 2023

Conversation

Mikearaya
Copy link
Contributor

No description provided.

Copy link
Member

@pozylon pozylon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bildschirm­foto 2023-03-22 um 09 54 28

-> Consistency: "Unchained Admin UI" instead of "Admin UI"

We copied the docs initially from https://www.apollographql.com/docs/
They have a "Home" part and once you select one of the productsI you see completely different side nav with the details.

Is this doable too instead of having just a link to one of the sections on the left when clicking admin ui?

@pozylon
Copy link
Member

pozylon commented Mar 22, 2023

http://localhost:8000/admin-ui/currency/ -> Don't use the word "Ethereum" because Unchained could support Solana, Cardano etc.

Always stay blockchain-neutral and write something like: If you add a crypto currency, you can optionally configure a contract address that can be used to distinguish tokens on a blockchain. A cryptocurrency payment plugin (for ex. cryptopay) can then optionally read that information and knows which currency is actually meant.

@pozylon
Copy link
Member

pozylon commented Mar 22, 2023

I like how you build the docs around the screenshots, this really helps the user to see where they are! Make sure to use ChatGPT to help you write better text:

For example "Unchained engine supports multiple authentication flows users can use to register and access it. The admin ui is designed to support most of this authentication and authorization flows with the exception of some that are better suited to a storefront instead of a control panel." is not very clear and needs further explanation. restructuring the text with chatgpt can help you get more specific for example you can write that although Unchained Engine supports a wider range of auth options like custom login handlers and that the admin ui only supports self-souvereign methods and very popular oAuth providers.

@pozylon
Copy link
Member

pozylon commented Mar 22, 2023

When you write the docs for users, products and assortments, make sure to add a bug issue for every bug you encounter in admin ui so you can fix those directly on master on that repository, no matter if it's just very small glitches or critical issues. For example I had issues doing variations and bundling stuff.

And also get specific about the product types, there is a lot of questions around that when I discussed this with Joel from Bob Pay, he currently builts a shop based on Unchained Engine for that company as a reference implementation of their service.

He also questioned how somebody can set prices and how the default pricing works, and it was not clear for him that a configurable product cannot have prices for example.

@Mikearaya Mikearaya force-pushed the plugin-docs-update branch from d3442d8 to 0b2658f Compare March 26, 2023 21:35
@Mikearaya Mikearaya requested a review from pozylon March 28, 2023 19:17
@pozylon
Copy link
Member

pozylon commented Mar 31, 2023

Admin UI stuff looks good, we could merge that already and then continue with the finetuning in another PR!

@pozylon pozylon marked this pull request as ready for review April 4, 2023 09:16
@pozylon
Copy link
Member

pozylon commented Apr 4, 2023

I'm merging this and add a more specific issue about the changes needed

@pozylon pozylon merged commit 8d57b71 into master Apr 4, 2023
@pozylon
Copy link
Member

pozylon commented Apr 4, 2023

@Mikearaya follow up: #557

@pozylon pozylon deleted the plugin-docs-update branch April 4, 2023 09:20
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