intel / rohd

The Rapid Open Hardware Development (ROHD) framework is a framework for describing and verifying hardware in the Dart programming language.
https://intel.github.io/rohd-website
BSD 3-Clause "New" or "Revised" License
374 stars 67 forks source link

Documents in `user_guide` aren't ideal for non-website viewing #374

Closed mkorbel1 closed 1 year ago

mkorbel1 commented 1 year ago

Describe the bug

The "user guide" isn't in an ideal format for users to peruse without referencing the official website.

For example, the links reference {{ site.baseurl }} which doesn't exist until Jekyll parses it: https://github.com/intel/rohd/blob/main/doc/user_guide/_docs/A11-interfaces.md

We should do a sweep through to see if there's any other issues like this.

Also, the file naming with "A11" etc. makes it annoying to add new documents inserted not at the end. Is there another convention or mechanism (table of contents instead?) that we could try?

To Reproduce

No response

Expected behavior

No response

Actual behavior

No response

Additional: Dart SDK info

No response

Additional: pubspec.yaml

No response

Additional: Context

No response