Skip to content

Conversation

waveproc
Copy link

Fixes c3lang/c3c#2331 and #156.

@lerno lerno requested a review from joshring August 28, 2025 18:25
@waveproc waveproc force-pushed the main branch 9 times, most recently from f736ac5 to a9f5361 Compare August 28, 2025 19:33
@waveproc
Copy link
Author

waveproc commented Aug 28, 2025

The "redirects" in astro.config.mjs make it difficult for others to contribute to c3-web. Also, I don't like how certain files/folders are hidden in the .vscode/settings.json, which is why I removed that file. Please check to see if the new CI script works.

@joshring
Copy link
Member

Could you not just do npm i and remove pnpm? I am not sure why that was even added, it would be good if we could remove it actually to make it easier to contribute it and have less steps

@joshring
Copy link
Member

Redirects are a fact of life on the internet. We need to support older links but we also want to update our links to new structures when we update things

@waveproc
Copy link
Author

Could you not just do npm i and remove pnpm? I am not sure why that was even added, it would be good if we could remove it actually to make it easier to contribute it and have less steps

The astro docs give the option of installing with pnpm or yarn, because those package managers offer signficant improvements over npm. I think npm should be deprecated.

Redirects are a fact of life on the internet. We need to support older links but we also want to update our links to new structures when we update things

Forking c3-web and running the CI script doesn't work without modifying the links. I think supporting older links is possible too, but that's a separate issue unless I'm mistaken.

@waveproc
Copy link
Author

Redirects are a fact of life on the internet. We need to support older links but we also want to update our links to new structures when we update things

Some frameworks handle this problem by supporting different versions of the docs you can go back to. For example, the pnpm docs support changing the version: https://pnpm.io/next/motivation.

@waveproc
Copy link
Author

waveproc commented Aug 29, 2025

So really I think that the redirects were done to simplify/shorten the URLs: https://web.archive.org/web/20240805175104/https://c3-lang.org/guide/my-first-project/

I don't think link rot matters too much when people can clone the entire repo and install the docs for offline use. Also, the lead developer of c3 has a "move fast and break things" approach. I think we should apply this principle to the docs as well.

@joshring
Copy link
Member

It might not matter to you but when that link is used externally and is someone's first interaction with c3 that's very different, they might think the project is dead

@joshring
Copy link
Member

Forking c3-web and running the CI script doesn't work without modifying the links. I think supporting older links is possible too, but that's a separate issue unless I'm mistaken.

Could you explain what you mean sorry?

@joshring
Copy link
Member

joshring commented Aug 29, 2025

Redirects are a fact of life on the internet. We need to support older links but we also want to update our links to new structures when we update things

Some frameworks handle this problem by supporting different versions of the docs you can go back to. For example, the pnpm docs support changing the version: https://pnpm.io/next/motivation.

This adds N different deployments to think about.
Alternatively integrating them we tried and it lead to search result duplicates and it wasn't so great.

@joshring
Copy link
Member

joshring commented Aug 29, 2025

I think we need to remove pnpm for now, and improve the readme along the lines you suggested and call it a day. If we need to tweak the dependencies to fix the build then that needs to get updated also.

@lerno
Copy link
Contributor

lerno commented Sep 23, 2025

What's the status for this one?

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.

Offline Doc/Handbook accompany with c3c distribution package
3 participants