calebjosue
Should not the links point to the latest version in the documentation?
I am reading (Once more) the Phoenix web framework documentation, in the From endpoint to views section contained in the Request life-cycle topic; The URL to the Plug documentation (The link is located in the second paragraph. [Plug] is a library and a specification…) right now is pointing to v1.16.1, should not the URL be updated to point to v1.18.1 instead?
I did not find (Doing a rather quick search) the repository to the documentation so I can propose a pull request.
Thanks.
Most Liked
rhcarvalho
The <> or </> symbol is often associated with “code”. The links are not necessarily to GitHub, it depends on the project configuration.
The documentation is written in Markdown format alongside the implementation of modules and functions.
The ex_doc library is the tool to extract the documentation and produce that nice website (and an ebook too!), and then it can publish the content to hexdocs.pm, a central repository of documentation.
You can also generate documentation for your own projects, even if you never intend to publish it online.
Now, why is it linking to version 1.16.1? I just checked, that is the version locked in phoenix/mix.lock at v1.8.1 · phoenixframework/phoenix · GitHub.
So I think ExDoc is interpreting Plug as a module and conservatively generating a link to the docs at the version the project has been tested with. I don’t know if that behavior is configurable.
Last Post!
calebjosue
Popular in Proposals: Ideas
Other popular topics
Latest Phoenix Threads
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #elixirconf-us
- #advent-of-code
- #distillery
- #processes
- #forms
- #api
- #metaprogramming
- #hex
- #security









