GithubHelp home page GithubHelp logo

Comments (1)

fireproofsocks avatar fireproofsocks commented on June 12, 2024

I understand the bewilderment, but this is normal functionality for ExDocs (you can see the "tabs" for Pages and Modules). Alternatively, you can specify dedicated markdown pages to be the default -- that's useful if you want to include guides or how-tos, but otherwise it's just a summary. Generally, the habit to get into with Elixir packages is to get familiar with navigating the modules -- that's where all the functions are documented. Sometimes it seems like you've stepped into an empty house (and sometimes projects are undocumented), but a lot of times you have to click thru to the modules. It can be frustrating, and I didn't really have an appreciation for the organization until I had to wander through the Erlang docs, and I could see how much Elixir has improved on that.

I've added the README to the docs and published v1.2.0 so the landing page is a nicer handoff.

from xray.

Related Issues (1)

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.