Skip to content

Archive most pages in the reference #566

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
May 24, 2025

Conversation

Noratrieb
Copy link
Member

@Noratrieb Noratrieb commented May 4, 2025

People continue being confused by these pages. This archives them effectively deleting their content. The old pages are still linked via GitHub permalink for the historians. This archiving strategy creating dead links to the existing pages.

@Noratrieb
Copy link
Member Author

@RalfJung

@ia0
Copy link

ia0 commented May 4, 2025

The Introduction of the Reference says "[This reference] is largely abandoned right now". Is the plan to resurrect it? Or should that disclaimer be made more visible? Or maybe even remove all sections except the Glossary?

@Lokathor
Copy link
Contributor

Lokathor commented May 4, 2025

if parts are known to be not current, we should delete them rather than have bad information in the book.

@Noratrieb
Copy link
Member Author

Noratrieb commented May 4, 2025

I've also thought about unpublishing the entire book off GitHub pages (so it's still present on GitHub but no longer published (or also gone from GitHub)) but I didn't like the idea of making the links dead. On the other hand we could just stub it all out on GitHub pages with a note on why it was removed and where to find the version. I think this is actually the best idea.

@Noratrieb
Copy link
Member Author

Noratrieb commented May 4, 2025

if parts are known to be not current, we should delete them rather than have bad information in the book.

It depends on what we want this book to be. If it's just about accurate descriptions then the entire thing should be deleted, because those belong in the Reference (the real Rust Reference, not this weird book).

@RalfJung
Copy link
Member

RalfJung commented May 4, 2025

I don't have a strong opinion on how to best frame this. However it seems odd that in the table of contents, we now have "suggestions" mixed with things that are not labeled as "suggestions".

Cc @rust-lang/opsem @chorman0773

@chorman0773
Copy link
Contributor

Frankly, my $.02 is that we deprecate the UCG as a whole and transition to making guarantees in the Reference (and other documents like the minirust spec for a more programmatic definition). In my view, this has been the de facto state for the past couple years anyways, with the repo being used as an issue tracker for outstanding technical questions for T-opsem.

@saethlin
Copy link
Member

saethlin commented May 7, 2025

I agree.

@RalfJung
Copy link
Member

RalfJung commented May 7, 2025

Yeah, makes sense. The glossary is still somewhat useful, as are the things in wip and resources. But most of the rest should be considered a historical document collecting information and plans from that time -- still potentially useful for someone making new plans / aiming to provide more layout guarantees, but not something programmers should refer to.

@Noratrieb
Copy link
Member Author

Okay, I'll rework the PR to archive these pages.

People continue being confused by these pages. This archives them all,
effectively deleting their content. The old pages are still linked via a
GitHub permalink for the historians. This archiving strategy avoids
creating dead links to the existing pages.
@Noratrieb Noratrieb force-pushed the layout-pages-nuclear branch from 5d8a63a to e0a71a2 Compare May 23, 2025 19:33
@Noratrieb Noratrieb changed the title Make disclaimer about this not being guarantees a lot more visible Archive most pages in the reference May 23, 2025
@Noratrieb
Copy link
Member Author

I implemented this, archiving all the pages except the glossary by replacing them with a stub.

@RalfJung
Copy link
Member

RalfJung commented May 24, 2025

LGTM, thanks! In terms of t-opsem people, @saethlin also agreed and nobody disagreed. @chorman0773 as a main contributor to these documents also agreed. So I'll go ahead and land this.

@RalfJung RalfJung merged commit 4ec33dc into rust-lang:master May 24, 2025
2 checks passed
@Noratrieb Noratrieb deleted the layout-pages-nuclear branch May 24, 2025 08:52
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants