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.

Sign up for GitHub

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

Jump to bottom

[FEATURE] Documentation opens #445

Closed
10 of 12 tasks
hasan7n opened this issue May 31, 2023 · 1 comment
Closed
10 of 12 tasks

[FEATURE] Documentation opens #445

hasan7n opened this issue May 31, 2023 · 1 comment
Assignees
@hasan7n
Labels
topic: documentation Improvements or additions to documentation type: enhancement New feature or request

Comments

@hasan7n
Copy link
Contributor

hasan7n commented May 31, 2023 •
edited
Loading

Some feedback from Alexandros Karagyris:

  • In the overview section of getting started, for each role listed, add links to the roles section.
  • Put the installation page within the getting started section
  • when using seed the server throughout the tutorial, make sure it is clear what it means
  • Use medperf server instead of solely server (or local medperf server)
  • use consistent names: medperf server, medperf client.
  • formal writing: remove words like We , Our
  • visuals for commands
  • write a FAQ section, moving most Notes to the FAQ section
  • emphasize more about the fact that these are experiments run against the local server, and that the same way can be applied for real experiments (figure out a way to make people understand that the tutorials act like instructions for there real executions)
  • there seem to be some markdown rendering bugs in the model owner demo
  • rename the section the software to MedPerf components. Maybe add some visuals in this section also
  • Use the same dataset/mlcubes for all tutorials (getting started, mlcube creation sections...)
@hasan7n hasan7n added topic: documentation Improvements or additions to documentation type: enhancement New feature or request High Priority Urgent tasks labels May 31, 2023
@hasan7n hasan7n self-assigned this May 31, 2023
@hasan7n hasan7n removed the High Priority Urgent tasks label Jun 18, 2023
@hasan7n
Copy link
Contributor Author

hasan7n commented Oct 22, 2023

Merging this into #416

@hasan7n hasan7n closed this as completed Oct 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hasan7n hasan7n

Labels
topic: documentation Improvements or additions to documentation type: enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hasan7n