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

Documentation: Parts and Fields (OCC-189) #348

Closed
agriffard opened this issue Sep 16, 2023 · 6 comments · Fixed by #364
Closed

Documentation: Parts and Fields (OCC-189) #348

agriffard opened this issue Sep 16, 2023 · 6 comments · Fixed by #364
Assignees

Comments

@agriffard
Copy link
Member

agriffard commented Sep 16, 2023

Make a documentation page for each kind of available part and field provided by the module:

  • Product
  • Price
  • PriceVariants

and attributes:

  • Boolean
  • Numeric
  • Text

Describe what it does but show also examples of Admin and front UI.

Jira issue

@github-actions github-actions bot changed the title Documentation: Parts and Fields Documentation: Parts and Fields (OCC-189) Sep 16, 2023
@porgabi
Copy link
Contributor

porgabi commented Oct 2, 2023

A page, as in a Markdown page within the repository (these do exist already but could be extended), or a dedicated demo page within the application itself?
cc @DAud-IcI

@agriffard
Copy link
Member Author

The current page is https://commerce.orchardcore.net/en/latest/features/products-and-prices/

A Markdown page per feature with screenshots could be interesting.

@porgabi porgabi self-assigned this Oct 2, 2023
@porgabi
Copy link
Contributor

porgabi commented Oct 7, 2023

Looking to test the new pages on the documentation site itself, which seems to require creating a separate version for the branch. As far as I can tell, this is not something I have permissions for, could you create one for the issue/OCC-189 branch?

@agriffard
Copy link
Member Author

You can test it locally:
https://docs.orchardcore.net/en/latest/docs/topics/docs-contributions/#running-the-documentation-site-locally

@agriffard
Copy link
Member Author

I built it and you can see the result here:
https://commerce.orchardcore.net/en/issue-occ-189/features/product-part/

@porgabi
Copy link
Contributor

porgabi commented Oct 9, 2023

Thanks!

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 a pull request may close this issue.

2 participants