New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1.0 Roadmap #202

Open
justinbmeyer opened this Issue Aug 28, 2015 · 3 comments

Comments

Projects
None yet
3 participants
@justinbmeyer
Member

justinbmeyer commented Aug 28, 2015

this is here because milestones don't support markdown as well as issues

This issue represents what could be considered an ideal "Documentation Product".

Goals:

A core product that focuses on reading files, converting that to something like a docMap and exporting that to consumable format.

The core product should be more or less agnostic to the types or format of those files, and to the final format. Instead it should focus on:

  • extensibility - make it easy to import custom tags, themes, and generators
  • development vs production concerns - make it easy to document locally, not on the "site repo" itself, including demo pages, but make it easily deploy-able.
  • user submitted content - make it possible to allow users to submit changes
  • happy path for git and npm users

With this core product in place, we might likely create two different extensions that can work together: a "js" and "css" extension. They would focus on meeting the needs of their user bases.

High-level tasks

  • Branding

We need a name for the core product. Ideally, it should fit in well with "DocumentJS" and "DocumentCSS".

  • Design new docConfig

I think something like the following in package.json for each released version:

"devDependencies": {
  "documentit": "1.1.0"
},
"documentit": {
  "extensions" : {
    "bitovi-theme": "0.1.X",
    "documentcss": "1.1.X",
    "documentjs": "1.2.X"
  }
}

And then something like this for the main site:

"devDependencies": {
  "documentit": "1.2.0"
},
"documentit": {
  "versions": {
      "npmVersions" : {
      "can": "MAX_MINOR( >1.2 <=2.2 )"
    },
    "2.3.0-pre" : "https://github.com/bitovi/canjs/tree/minor",
    "3.0.0-pre" : "https://github.com/bitovi/canjs/tree/major",
   }

  "defaultVersion": "
}
  • __Implement
@ramblinjan

This comment has been minimized.

Show comment
Hide comment
@ramblinjan

ramblinjan Aug 28, 2015

Contributor

Separate Tasks for Users: Creating Content and Customizing Site

Ideally, workflow, documentation, and design will take into account that actually documenting or creating content is a task that should generally happen independently of customizing a site. Currently they often happen in parallel and I think this has proven confusing for people unfamiliar with documentjs (and especially designers).

Contributor

ramblinjan commented Aug 28, 2015

Separate Tasks for Users: Creating Content and Customizing Site

Ideally, workflow, documentation, and design will take into account that actually documenting or creating content is a task that should generally happen independently of customizing a site. Currently they often happen in parallel and I think this has proven confusing for people unfamiliar with documentjs (and especially designers).

@chasenlehara

This comment has been minimized.

Show comment
Hide comment
@chasenlehara

chasenlehara Feb 1, 2017

Member

@justinbmeyer, given the existence of bit-docs, it’d be really nice to hear your thoughts on how it relates to the future of DocumentJS.

Member

chasenlehara commented Feb 1, 2017

@justinbmeyer, given the existence of bit-docs, it’d be really nice to hear your thoughts on how it relates to the future of DocumentJS.

@justinbmeyer

This comment has been minimized.

Show comment
Hide comment
@justinbmeyer

justinbmeyer Feb 1, 2017

Member

it will replace DocumentJS when we have time to polish it off.

Member

justinbmeyer commented Feb 1, 2017

it will replace DocumentJS when we have time to polish it off.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment