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

Broken links in Elmish page #31

Open
filippo opened this issue Jan 7, 2022 · 3 comments
Open

Broken links in Elmish page #31

filippo opened this issue Jan 7, 2022 · 3 comments

Comments

@filippo
Copy link

filippo commented Jan 7, 2022

Hi, there are some broken links in the Elmish page:
https://elmish.github.io/elmish/

There's a /docs/ missing.

Here are the links:

"basics example"
https://elmish.github.io/elmish/basics.html
Should be:
https://elmish.github.io/elmish/docs/basics.html

Parent-child example:
https://elmish.github.io/elmish/parent-child.html
Should be:
https://elmish.github.io/elmish/docs/parent-child.html

Subscriptions example:
https://elmish.github.io/elmish/subscriptions.html
Should be:
https://elmish.github.io/elmish/docs/subscription.html

If you want I can try to make a pull request

@et1975
Copy link
Member

et1975 commented Jan 7, 2022 via email

@MangelMaxime
Copy link
Member

Ah yes, I removed the "embedded" version of the demos when re-designing https://elmish.github.io/ website.

Instead of creating an embedded version of the example, I directly linked to the demo websites. See links under the Examples category at the bottom of https://elmish.github.io/.

I see 2 solutions:

  1. We fix the broken links to point to the demo app or repository
  2. We re-add embedded version of the demos application

The problem I have with the current demo pages is that they aren't really friendly... There is no explanation, no links to the source code, etc.

Should be add a documentation website to the demo or should we just link to the repository and have a well written README.md file ?

If you add a documentation website, it is possible to use literate documentation to have the code and the documentation in the same file.

@et1975
Copy link
Member

et1975 commented Jan 7, 2022

Right, the live samples were kinda dangling in vacuum. I'm onboard with the 1st option, having links and better readme that lets you see it live.

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

3 participants