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

docs: 22-restructure-document-following-iso-style #58

Merged
merged 8 commits into from
Nov 28, 2024

Conversation

ssteinbuss
Copy link
Contributor

What this PR changes/adds

Adding mandatory sections as required by ISO style:

  • Foreword
  • Introduction
  • Scope
  • normative references
  • Terms and definitions

Why it does that

ISO style is targeted for the document

Further notes

index.md for respec is updated accordingly.

Linked Issue(s)

Closes # <-- insert issue number if one exists

Please be sure to take a look at the contributing guidelines and our etiquette for pull requests.

@ssteinbuss ssteinbuss linked an issue Nov 19, 2024 that may be closed by this pull request
@ssteinbuss ssteinbuss self-assigned this Nov 19, 2024
Copy link
Contributor

@arnoweiss arnoweiss left a comment

Choose a reason for hiding this comment

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

Reach out if there's further explanation needed.

model/terminology.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
index.html Show resolved Hide resolved
@jimmarino
Copy link
Contributor

@ssteinbuss Sorry I accidentally committed @arnoweiss suggestion. I hit the wrong button. Can you revert it?

* removing external references as required by ISO guidance
Copy link
Contributor

@arnoweiss arnoweiss left a comment

Choose a reason for hiding this comment

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

I'll go ahead and fix the review comments in a separate PR. Thanks for creating the new issue.

@ssteinbuss
Copy link
Contributor Author

@jimmarino can you approve please?

@ssteinbuss ssteinbuss merged commit 11a6735 into main Nov 28, 2024
2 checks passed
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 this pull request may close these issues.

Restructure document following ISO style
3 participants