Skip to content
This repository has been archived by the owner on Mar 5, 2019. It is now read-only.

Latest commit

 

History

History
160 lines (156 loc) · 7.14 KB

TODO.md

File metadata and controls

160 lines (156 loc) · 7.14 KB
Raw

CHANGES :

DONE

  • form to register api (create/update/delete) from several source/format : javadoc2, scaladoc, scaladoc2, vscaladoc2 (json)
  • user can list api
  • user can browse vscaladoc2 api (json) in html
  • api registration
    • auto registration of artifacts from a info.ArtifactInfo (support for multi-module project/apis) to avoid long and annoying registration for every modules

TODO, ideas

  • write the announce
  • document
    • title + description
    • how to use
    • planning
    • eg : url format, api laf, json format (to help complementary tool developers)
  • promotion
    • nice product
    • write announce
  • site look
    • change the font of the title
    • add a quick presentation text on home page
    • add links to legals, source, issue/feebacks, TODO/changelog,...
    • try other look for site page
    • may be integrate compass
    • api listing : display kind, logo, tags
    • ranking of artifact
    • add page to search
      • artifact
      • Type
        • by name
        • by signature
      • method
        • by name
        • by signature
    • add news
    • enable contact form (if user not logged => captcha)
    • add doc for users (api provider (syntax, running of genjson, register,...), laf provider, doctaglet provider, third-party/mashup tool)
  • api laf
    • laf SPI
      • allow import/upload of laf (navigator/
      • simplify and document development
      • upload of css for selected laf
      • add support to test skin without remote server
        • provide a json sample
        • create a stand-alone local generator to convert json into static html site (like before).
    • default skin
      • document
        • how to customize, test, submit patch, ...
      • navigator0
        • replace select box of package by a list of checkbox with link to package page
        • roundify
        • provide a chat (widget) (one room per artifact)
        • result from search filter should highlight (bold) matching fragment in the name
        • provide an index of methods (like javadoc, scaladoc2 (trunk))
      • entity0
        • provide logo info
        • change style of headers (h1,...) into description section
        • hide Any/AnyRef's methods
        • link display of
        • add helper.toInfo(uoa)
        • error sur display de methods (non available, non vscaladoc2) => link to origin
        • integrate a user comment support
          • extrenal service : Disqus, IntenseDebate, JS-Kit, SezWho, ...
          • collabdoc
          • home made (comments hide by default, number of comments, treeview, add (only for register user))
          • using a mailing-list (google groups, google wave fork)
          • target features :
            • no spam control : moderation, delete (administration)
            • notification : email or rss (granularity item + sub : artifact(s), version, package, type, fieldext
            • retreive/display/add comments (lowest granularity)
            • reply by email ?
  • api registration
    • register lift-2.2-M1
      • generate (with logo)
      • link
    • register scalatest
    • register vscaladoc2_genjson, vscaladoc2_www
    • register non vscaladoc2 api (javadoc2 for java lib, lead scala lib (specs, scalatest, ...)
    • allow registered user (or unregistered user via captcha validation) to register remote api
    • add button to scan local api @local @admin
    • auto registration of artifacts from a info.ArtifactInfo (support for multi-module project/apis) to avoid long and annoying registration for every modules
  • user registration
    • configure a MailServer (check email, and send forgotten password)
    • support user preferences
      • default navigator
      • default skin to use
      • default css to use
      • display inherited
      • favorite artifact
  • add tags supports
    • tags from source/json AND from user (restrited to owner or registered ?)
    • at artifact level
      • display in overview
      • display in listing (allow as filter)
    • at Type level
      • use as filter in listing
    • at Fieldext level
      • use as filter in listing
  • add source link/display
    • support several mode :
      • link to external source via pattern with substitution by ${artifactId} ${version} ${filePath} ${lineNum} (suggest template for sxr, svn, github,...)
      • embedded : source are near json
    • www should display embedded source
    • use to display sample/demo/test code
  • doctaglets
    • always display tags in the same order (eg : @deprecated @param @return @throws+@exception @author @version @since @see ...)
    • provide custom display for @tags (cloud, hide,...)
    • provide custom display for @todo @TODO
    • provide custom display for @deprecated
    • provide custom display for @see
    • use captcha for email (in author)
    • find a way to allow development and registration of doctaglet
    • create a graph view (interactive via applet, not interactive via image + link) for type relation, package dependencies,...
  • optimisation :
  • misc :
    • rss feed : comments, new/update about api entry, news
    • support api registration by archive upload
    • if user try to access unknow api, provide a form to register the api
    • generate Sitemap and submit updates to google doc

inspirations (to review)