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

Konsolidér dokumentation af brugerinstallation #637

Open
4 tasks
xidus opened this issue Aug 15, 2022 · 0 comments
Open
4 tasks

Konsolidér dokumentation af brugerinstallation #637

xidus opened this issue Aug 15, 2022 · 0 comments
Assignees

Comments

@xidus
Copy link
Collaborator

xidus commented Aug 15, 2022

Jævnfør tråden i #619 opretter jeg her en opfølgende opgave med at placere materiale i Git-arkivets README.md, der kom med #636, i vores automatisk-opdaterede dokumentationsapparat, og i README.md istedet henvise til dette sted.

Formålet er, at brugerne kun skal have ét sted at gå til for at læse en opdateret, anbefalet og korrekt fremgangsmåde til at installere og opdatere FIRE.

Opgaver:

  • Udvid installationsvejledningen i Sphinx-dokumentationen, så fremgangsmåden er klar og tydelig. Der skal være én anbefalet måde at sætte FIRE op på. Der skal være én anbefalet måde at opdatere FIRE på.
  • Brug istedet README.md til nogle konkrete eksempler og illustrationer af brugsscenarier. (Brug eventuelt mermaid til at tegne diagrammer med, da GitHub understøtter dette.)
  • Henvis i README.md til den aktuelle dokumentation for den seneste version af FIRE.
  • Gør eventuelt installationsvejledningens eksempler dynamiske ved at hente den aktuelle version ind i dokumentet, så den kan bruges i kommando-eksemplerne.
@xidus xidus self-assigned this Aug 15, 2022
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

No branches or pull requests

1 participant