Skip to content

Conversation

@francis-tanyx
Copy link
Contributor

PR Checklist

What requirement is this design document for?

#Issue #51

Anything the reviewer should know when reviewing this PR?

  • This PR will close issue #51.
  • Page heading and subheading were added for pipeline-server.md as it did not originally had any
  • Page heading was added for retail-data-visualization.md as it did not originally had any

If there are any other design Pull Requests or requirements, please link them here (i.e. intel-retail/automated-self-checkout )

intel-retail/automated-self-checkout#677

… a Services section under Automated Self Checkout in Documentation Repo

- created section `Services` under Use Cases/Automated Self Checkout
- renamed the files based on the service (common-service, pipeline-server, retail-data-visualization)
- updated the mkdocs.yml with the new files under a section called Services
- ensured that visualization works for docs

Issue (intel-retail#51)[intel-retail#51] 
 
Co-authored-by: Voon Yong Shing <yong.shing.voon@intel.com>
Signed-off-by: Tan Yan Xue <yan.xue.tan@intel.com>
Signed-off-by: Ong Jing Hong <jing.hong.ong@intel.com>
Signed-off-by: Marcus Khaw Chin Rui <marcus.chin.rui.khaw@intel.com>
Signed-off-by: Low Yu Zhe <yu.zhe.low@intel.com>
@francis-tanyx
Copy link
Contributor Author

cleaned up commits in this new PR

@ejlee3 ejlee3 added documentation Improvements or additions to documentation oss_hackathon labels Mar 7, 2025
Copy link
Contributor

@ejlee3 ejlee3 left a comment

Choose a reason for hiding this comment

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

LGTM

NeethuESim
NeethuESim previously approved these changes Apr 1, 2025
Copy link
Contributor

@NeethuESim NeethuESim left a comment

Choose a reason for hiding this comment

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

LGTM

antoniomtz
antoniomtz previously approved these changes Apr 1, 2025
Copy link
Contributor

@ejlee3 ejlee3 left a comment

Choose a reason for hiding this comment

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

Can we grab the latest file from the repository - some things changed from a PR that was merged from the OSS hackathon in the common-service.md and retail-data-visualization.md was removed as well.

Removing Retail Data Visualization Markdown due to its removal on other PR
Removal of Retail Data Visualization documentation due to its removal on PR: intel-retail/automated-self-checkout#684
Modified common-service.md as PR: intel-retail/automated-self-checkout#684 has modifications
@NeethuESim
Copy link
Contributor

@francis-tanyx are the changes suggested by @ejlee3 incorporated in this PR. We need to merge this first & then the PR - intel-retail/automated-self-checkout#704

@francis-tanyx francis-tanyx dismissed stale reviews from antoniomtz and NeethuESim via bc3cca0 April 23, 2025 18:10
@francis-tanyx
Copy link
Contributor Author

@francis-tanyx are the changes suggested by @ejlee3 incorporated in this PR. We need to merge this first & then the PR - intel-retail/automated-self-checkout#704

Yes I confirm the changes are done,

  • removed the old retail-data-visualization.md
  • updated common-service.md

unsure if the contents in retail-data-visualization.md is migrated

@francis-tanyx francis-tanyx requested a review from ejlee3 May 7, 2025 06:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation oss_hackathon

Projects

None yet

Development

Successfully merging this pull request may close these issues.

refactor: move documentation from individual services to a new section under Automated Self Checkout in doc repo

4 participants