Skip to content

Conversation

danielmrichter
Copy link
Contributor

This creates a "more details" page and populates it with data. The pdf links are all still a WIP on those pages. The link is in the body because it breaks formatting if it is in the footer.

Copy link
Contributor

@jjscheel jjscheel left a comment

Choose a reason for hiding this comment

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

I'm not sure this commit is needed as @BlackstoneEngineering has already taken care of this. (Note this was in reference to commit 754f385.)

@jjscheel
Copy link
Contributor

jjscheel commented Sep 9, 2025

I'm also fine with commit d44c1fb staying as Search is pretty stable and the UI impacts are minimal. Now, I'm sure there's things will learn and get to work on, but that's true of everything we'll enable.

@jjscheel
Copy link
Contributor

jjscheel commented Sep 9, 2025

Commits 8701c85 and 04d971f have already been address by @BlackstoneEngineering as well.

@jjscheel
Copy link
Contributor

jjscheel commented Sep 9, 2025

I do like the idea of maintaining the detailed information in a json file. I'll observe that we likely have 2 style templates. A base template that includes community, repo, and history. Then ISA templates have that information, plus information about ratified but not included extensions, and the archived (included) information (with links to standalone docs).

@BlackstoneEngineering
Copy link
Collaborator

Things noted:

  1. Why not just have these be .mdx files? Easier to edit and maintain no?
  2. The dowload pdf links do not work
  3. Technically it's fine, but I wont be responsible for maintaining these pages as they are non-standard implementations.
Screenshot 2025-09-09 at 9 07 58 AM

@danielmrichter
Copy link
Contributor Author

I'm not sure this commit is needed as @BlackstoneEngineering has already taken care of this. (Note this was in reference to commit 754f385.)

Think this was an artifact of me merging main in along the way, not sure why it's showing up as my commit now. Same with the other two.

@jjscheel
Copy link
Contributor

jjscheel commented Sep 9, 2025

  1. Why not just have these be .mdx files? Easier to edit and maintain no?

The only advantage to working in a json file is that the formatting of all these pages becomes templatized and the information just gets presented.

We technically are going to have 2 types of templates -- The basic template like I've manually put in PR #49 and the Extended details for the ISA manuals that Daniel has created.

Thoughts?

@jjscheel
Copy link
Contributor

jjscheel commented Sep 9, 2025

  1. The dowload pdf links do not work

The links won't work until we upload the new PDFs. Which, BTW, we might want to define a PDF naming structure for these.

We decided these should land in Antora, right?

@danielmrichter
Copy link
Contributor Author

Things noted:

1. Why not just have these be `.mdx` files? Easier to edit and maintain no?

2. The dowload pdf links do not work

3. Technically it's fine, but I wont be responsible for maintaining these pages as they are non-standard implementations.
Screenshot 2025-09-09 at 9 07 58 AM

Sorry, should have addressed this. I wrote about it in a draft pr that's sitting out there. In conversations I had, there was an interest in these pages being pretty unique to each topic, since the details they'd contain would be quite different. The actual visualization of those details wasn't obvious at the time, so I set the pattern to start with react components to have more control. If it's overkill for the future, then changing them to mdx in the future would be easier than if the flexibility was needed and they needed to go from mdx to react.

Resolved the other issues. One was a bad copy and paste and the other was meant to be placeholder until the actual PDFs were in there, so I just commented out the render for that.

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.

5 participants