Coder Social home page Coder Social logo

Comments (3)

josevalim avatar josevalim commented on August 16, 2024

The docs are generated here: https://github.com/elixir-lang/docs . I think docs/ would indeed be better as it would be the thing most people would try from the URL.

I also wanted for a while to split the generated docs per application. So we generate one page for EEx, Mix, and so on. So if you are willing to send a PR (probably to this repo, the docs repo and the Elixir one), it would be really appreciated!

from elixir-lang.github.com.

alco avatar alco commented on August 16, 2024

Oh, the docs repo is automatically picked up because of the redirection from elixir-lang.org to elixir-lang.github.io, right? I forgot about that.

The docs.html in this repo is processed by jekyll. It has this header:

---
title: Elixir Documentation
section: docs
layout: default
---

I need to either add generated docs.html to the docs repo or add layouts to the docs repo.

Regarding the separate pages per app, do you want them to have different URLs? Like elixir-lang.org/docs/stable/eex? Will each one have a different nav on the left of the page?

from elixir-lang.github.com.

josevalim avatar josevalim commented on August 16, 2024

The docs.html in this repo is processed by jekyll. It has this header:

Gah. That would make things harder (and possibly inconsistent). Maybe we can add a redirect from docs/ to docs.html for those who want to access docs/ directly.

Regarding the separate pages per app, do you want them to have different URLs?

Yeah, it definitely needs different URLs. In theory /docs/stable/APP is better because it is easier to move docs from master to stable (I need to do this operation on very release).

from elixir-lang.github.com.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.