search

intel / ACON

Apache License 2.0
56 stars 16 forks source link

aconcli: Remove broken link in aconcli README #2

Closed xxu36 closed 1 year ago

xxu36 commented 1 year ago

Fix issue #1

dcmiddle commented 1 year ago

@xxu36 where did this CLI documentation move to though? I don't see it in the existing docs I read through. Was it intentionally removed or accidentally lost during the repo reorganization?

xxu36 commented 1 year ago

@xxu36 where did this CLI documentation move to though? I don't see it in the existing docs I read through. Was it intentionally removed or accidentally lost during the repo reorganization?

@dcmiddle I think previously we had CLI documentation under doc directory. Before we made the repo public we submitted a commit to remove several immature docs which included the CLI doc. I think I can upload the updated CLI doc in a new commit.

svenkata9 commented 1 year ago

@xxu36 Can we fix that as part of this PR itself - add the CLI doc and update the link?

xxu36 commented 1 year ago

@svenkata9 Makes sense. Then I will update this PR directly once the doc is ready.

binxing commented 1 year ago

aconcli is under active development so it's hard to maintain a user manual that always matches the code. Let's put more details in aconcli's help messages and use a QuickStart.md to give users an orientation on what should be done and in what order.

dcmiddle commented 1 year ago

closed in favor of #5.