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

[Discussion] How do we deal with deprecated documentation sources? #56

Open
codeZeilen opened this issue Jul 19, 2023 · 0 comments
Open

Comments

@codeZeilen
Copy link
Contributor

How do we deal with deprecated documentation sources on the web page?

The following situation just came up: I discovered that the link on Waveplace Beta Morphic Tutorials on Documentation does not work anymore. I was able to retrieve an earlier version from Wayback Machine: old version. When thinking about how to fix this I thought to either:

a) remove the link completely
b) use the wayback machine URL

I don't like either solution. a) is the clean solution that leads to a documentation page that is useful for current users of Squeak. b) keeps original resources on Squeak around which might be useful for special purposes but makes the documentation page much less useful for current/new users.

There might be an alternative c) which is to add a "Deprecated Documentations" section. However, this might lead to many of the current documentation links to be moved to that section.

Other thoughts? I have no strong opinion other than that we should improve the Documentation page so that new users can quickly find information that is actually useful to them.

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

No branches or pull requests

1 participant