NuDoq Feedback

Welcome to the NuDoq feedback forums!

Please help us make NuDoq the best API documentation platform ever :)

I suggest you ...

You've used all your votes and won't be able to post a new idea, but you can still search and comment on existing ideas.

There are two ways to get more votes:

  • When an admin closes an idea you've voted on, you'll get your votes back from that idea.
  • You can remove your votes from an open idea you support.
  • To see ideas you have already voted on, select the "My feedback" filter and select "My open ideas".
(thinking…)

Enter your idea and we'll search to see if someone has already suggested it.

If a similar idea already exists, you can support and comment on it.

If it doesn't exist, you can post your idea so others can support it.

Enter your idea and we'll search to see if someone has already suggested it.

  1. Push NuDoq to GitHub so it can be iterated quickly.

    Clarius has a history of posting neat projects and then abandoning them. Visual T4 is a prime example. NuDoq is a great idea, it would be nice if you could post it on GitHub so that other people can send pull requests, contribute features, etc,

    42 votes
    Vote
    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
    • facebook
    • google
      Password icon
      I agree to the terms of service
      Signed in as (Sign out)
      You have left! (?) (thinking…)

      We’re planning this right now. We need to make sure that the “accept PR → publish → re-parse packages” flow is seamless so that new features can be up in production quickly.

    • Add a way to manually refresh the docs when a new package is uploaded.

      My XamlEssentials documentation (http://www.nudoq.org/#!/Projects/XamlEssentials) is stuck on my 3.3.3 package, when my 3.4 package is now available. I'd like to be able to trigger a refresh somehow, so "stuck" docs can be re-imported.

      34 votes
      Vote
      Sign in
      Check!
      (thinking…)
      Reset
      or sign in with
      • facebook
      • google
        Password icon
        I agree to the terms of service
        Signed in as (Sign out)
        You have left! (?) (thinking…)
      • Devise a standard for additional docs

        It seems that at present NuDoq only works with docs generated from summary comments. It would be great if developers could add additional documentation to their NuGet packages, in Markdown, maybe below a Docs folder?

        27 votes
        Vote
        Sign in
        Check!
        (thinking…)
        Reset
        or sign in with
        • facebook
        • google
          Password icon
          I agree to the terms of service
          Signed in as (Sign out)
          You have left! (?) (thinking…)
        • Document what NuDoq looks for when generating documentation

          Perhaps I have missed it, but I see no mention as to exactly how/what is needed to get a project "automatically" included into NuDoq. A quick blurb on the main site could correct this.

          1. is project selection based on github tags? languages? presumably C# and other .NET targeted languages, but what exactly is the criteria for consideration in NuDoq?

          2. Does the xml documentation need to live in a specific folder?

          3. Does the xml and assembly need to be in the same folder?

          4. Are there any naming rules that need to be observed? required extensions?

          5. Is…

          23 votes
          Vote
          Sign in
          Check!
          (thinking…)
          Reset
          or sign in with
          • facebook
          • google
            Password icon
            I agree to the terms of service
            Signed in as (Sign out)
            You have left! (?) (thinking…)
          • Exclude types/members decorated with [EditorBrowsable(EditorBrowsableState.Never)]

            Since [EditorBrowsable(EditorBrowsableState.Never)] means "don't show to intellisense" it would be great if adding this attribute was interpreted as "don't show in the documentation".

            Or alternatively have some other comment based convention that allows people to hide members from the documentation.

            21 votes
            Vote
            Sign in
            Check!
            (thinking…)
            Reset
            or sign in with
            • facebook
            • google
              Password icon
              I agree to the terms of service
              Signed in as (Sign out)
              You have left! (?) (thinking…)
            • Integrate it into nuget.org

              Actually contribute code to nuget.org so it is all integrated in the same place.

              18 votes
              Vote
              Sign in
              Check!
              (thinking…)
              Reset
              or sign in with
              • facebook
              • google
                Password icon
                I agree to the terms of service
                Signed in as (Sign out)
                You have left! (?) (thinking…)
              • Have a private version I can use/host to index my company's internal tools/libraries (ie. a replacement for what I use Sandcastle for now)

                My company has a number of projects and libraries that have XML comments that we currently package and somewhat make available as Sandcastle-generated HTML files. It'd be great if there was a version of this (preferably something we could host internally, but SAAS could be an option) that would index and expose all this stuff we have sitting around to our internal developers.

                17 votes
                Vote
                Sign in
                Check!
                (thinking…)
                Reset
                or sign in with
                • facebook
                • google
                  Password icon
                  I agree to the terms of service
                  Signed in as (Sign out)
                  You have left! (?) (thinking…)
                • Show source next to documentation

                  If a package contains source symbols or source server support, it is possible to retrieve the source code of the package. This means you can create something like ms reference source, which would be awesome for open source projects.

                  An easy way to add source server support is GitLink (see https://github.com/gittools/gitlink)

                  13 votes
                  Vote
                  Sign in
                  Check!
                  (thinking…)
                  Reset
                  or sign in with
                  • facebook
                  • google
                    Password icon
                    I agree to the terms of service
                    Signed in as (Sign out)
                    You have left! (?) (thinking…)
                  • Show a 'completeness' score for package documentation

                    It would be cool to see what percentage of the code is documented. I think this would help users decide if docs are worth reading, and encourage package owners (like me) to improve the docs.

                    It would be worth having a heuristic to avoid things like this:

                    + /// <summary>
                    + /// Toes the query string.
                    + /// </summary>
                    + /// <param name="hash">The hash.</param>
                    + /// <returns>Query String</returns>
                    internal static string ToQueryString(this HashParams hash)

                    13 votes
                    Vote
                    Sign in
                    Check!
                    (thinking…)
                    Reset
                    or sign in with
                    • facebook
                    • google
                      Password icon
                      I agree to the terms of service
                      Signed in as (Sign out)
                      You have left! (?) (thinking…)
                      1 comment  ·  Admin →
                    • 12 votes
                      Vote
                      Sign in
                      Check!
                      (thinking…)
                      Reset
                      or sign in with
                      • facebook
                      • google
                        Password icon
                        I agree to the terms of service
                        Signed in as (Sign out)
                        You have left! (?) (thinking…)
                      • 9 votes
                        Vote
                        Sign in
                        Check!
                        (thinking…)
                        Reset
                        or sign in with
                        • facebook
                        • google
                          Password icon
                          I agree to the terms of service
                          Signed in as (Sign out)
                          You have left! (?) (thinking…)
                        • Link to MSDN types

                          Currently doing a Google search.

                          8 votes
                          Vote
                          Sign in
                          Check!
                          (thinking…)
                          Reset
                          or sign in with
                          • facebook
                          • google
                            Password icon
                            I agree to the terms of service
                            Signed in as (Sign out)
                            You have left! (?) (thinking…)
                          • 7 votes
                            Vote
                            Sign in
                            Check!
                            (thinking…)
                            Reset
                            or sign in with
                            • facebook
                            • google
                              Password icon
                              I agree to the terms of service
                              Signed in as (Sign out)
                              You have left! (?) (thinking…)
                              1 comment  ·  Admin →
                            • Group namespaces across assemblies

                              E.g. at http://www.nudoq.org/#/Packages/Serilog/Serilog/Serilog

                              In the left-hand "Namespaces" sidebar, the "Serilog" namespace is repeated, possibly once for each assembly it is contained in.

                              6 votes
                              Vote
                              Sign in
                              Check!
                              (thinking…)
                              Reset
                              or sign in with
                              • facebook
                              • google
                                Password icon
                                I agree to the terms of service
                                Signed in as (Sign out)
                                You have left! (?) (thinking…)
                                1 comment  ·  Admin →
                              • Fix example snippets

                                Example code snippets for my API docs are missing (eg. see remarks in http://www.nudoq.org/#/Packages/Kent.Boogaart.KBCsv/Kent.Boogaart.KBCsv/CsvReader). Works from SHFB (see doc download at http://kbcsv.codeplex.com/releases/view/110767).

                                5 votes
                                Vote
                                Sign in
                                Check!
                                (thinking…)
                                Reset
                                or sign in with
                                • facebook
                                • google
                                  Password icon
                                  I agree to the terms of service
                                  Signed in as (Sign out)
                                  You have left! (?) (thinking…)
                                • Provide information for package owners

                                  As the package author, I'd love to know why document generation for my package failed. When I found nudoq.org, I added xml to my packages and updated the package, but so far no difference. (The way how to add documentation is not described, in my previous version I had the xml files, but not listed in package.xml, now I listed them but without any visible effect)

                                  4 votes
                                  Vote
                                  Sign in
                                  Check!
                                  (thinking…)
                                  Reset
                                  or sign in with
                                  • facebook
                                  • google
                                    Password icon
                                    I agree to the terms of service
                                    Signed in as (Sign out)
                                    You have left! (?) (thinking…)
                                  • Pre-release packages too, please.

                                    Pre-release packages too, please.

                                    4 votes
                                    Vote
                                    Sign in
                                    Check!
                                    (thinking…)
                                    Reset
                                    or sign in with
                                    • facebook
                                    • google
                                      Password icon
                                      I agree to the terms of service
                                      Signed in as (Sign out)
                                      You have left! (?) (thinking…)
                                    • MyGet Integration

                                      Integrate with MyGet.org

                                      4 votes
                                      Vote
                                      Sign in
                                      Check!
                                      (thinking…)
                                      Reset
                                      or sign in with
                                      • facebook
                                      • google
                                        Password icon
                                        I agree to the terms of service
                                        Signed in as (Sign out)
                                        You have left! (?) (thinking…)
                                      • Have a "Recently Changed" page

                                        So we can see recent activity on NuDoc. Would give more of a sense of community.

                                        4 votes
                                        Vote
                                        Sign in
                                        Check!
                                        (thinking…)
                                        Reset
                                        or sign in with
                                        • facebook
                                        • google
                                          Password icon
                                          I agree to the terms of service
                                          Signed in as (Sign out)
                                          You have left! (?) (thinking…)
                                        • Support multiple doc files per package

                                          Let you be able to pick from multiple documentation files in a package (for example, when a library supports different features for different platforms.

                                          3 votes
                                          Vote
                                          Sign in
                                          Check!
                                          (thinking…)
                                          Reset
                                          or sign in with
                                          • facebook
                                          • google
                                            Password icon
                                            I agree to the terms of service
                                            Signed in as (Sign out)
                                            You have left! (?) (thinking…)
                                          ← Previous 1
                                          • Don't see your idea?

                                          NuDoq Feedback

                                          Feedback and Knowledge Base