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

Improve title of the standard document (add "FMI" ...) #57

Closed
GallLeo opened this issue May 15, 2024 · 0 comments · Fixed by #59
Closed

Improve title of the standard document (add "FMI" ...) #57

GallLeo opened this issue May 15, 2024 · 0 comments · Fixed by #59
Milestone

Comments

@GallLeo
Copy link
Contributor

GallLeo commented May 15, 2024

The current heading of the document states

Layered Standard for XCP
(https://github.com/modelica/fmi-ls-xcp/blob/main/docs/index.adoc#layered-standard-for-xcp)

The readme states

FMI Layered Standard XCP (fmi-ls-xcp)
(https://github.com/modelica/fmi-ls-xcp)

From my point of view, the heading should

  • include "FMI",
  • maybe include the abbreviation "fmi-ls-xcp" (at least the abbreviation should be written somewhere in the document)
  • Gramatically work for all currently planned layered standards. Current status:
    • fmi-ls-bus:
      • adoc: "Layered Standard for Network Communication"
      • readme: "FMI Layered Standard Network Communication"
    • fmi-ls-ref
      • adoc: "FMI Layered Standard REF"
      • readme: "Layered Standard References"
    • fmi-ls-struct
      • adoc: "fmi-ls-struct"
      • readme: "Layered Standard for Structured Data"

Taking all this into consideration, my proposal for the title would be:
"FMI Layered Standard for XCP (fmi-ls-xcp)"

@GallLeo GallLeo added this to the v1.0 milestone May 15, 2024
@PTaeuberDS PTaeuberDS linked a pull request May 24, 2024 that will close this issue
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.

1 participant