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

Small improvements for Architecture.md, TreeExample.md #327

Merged
merged 9 commits into from
Mar 30, 2023

Conversation

chykon
Copy link
Contributor

@chykon chykon commented Mar 21, 2023

Description & Motivation

It is proposed to make small changes to the Architecture.md and TreeExample.md files:

  • Rename files to follow snake_case
  • Fix typos, remove extra spaces
  • Update code in TreeExample.md (updated code is taken from example/tree.dart)
  • Update generated SystemVerilog in TreeExample.md
  • Update links to renamed files

Related Issue(s)

No.

Testing

Not required.

Backwards-compatibility

Is this a breaking change that will not be backwards-compatible? If yes, how so?

Old links to renamed files will no longer work.

Documentation

Does the change require any updates to documentation? If so, where? Are they included?

The proposed changes for Architecture.md and TreeExample.md do not affect the actual content.

@chykon
Copy link
Contributor Author

chykon commented Mar 21, 2023

Need to restart CI after some time due to external links check failure.

@chykon
Copy link
Contributor Author

chykon commented Mar 22, 2023

Because README.md currently cannot use relative links (this results in an error when checking the documentation) (dart-lang/dartdoc#1096), there was a chicken-and-egg problem with checking links. It is proposed to temporarily add the path to the new file to the ignore list so that the PR will complete successfully.

If such a solution is suitable, then we will need to remember to remove the path from the ignore list.

Copy link
Contributor

@mkorbel1 mkorbel1 left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!

The workaround with ignore seems acceptable to me

@mkorbel1 mkorbel1 merged commit a30b4c6 into intel:main Mar 30, 2023
@chykon chykon deleted the doc-improvements branch March 31, 2023 18:40
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.

None yet

2 participants