bitovi / bitovi/documentjs

1.0 Roadmap

Open
#202 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
598
Forks
371
PR merge metrics
No merged PRs in 30d

Description

_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:

``` js
"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:

``` js
"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

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the roadmap goals and the package.json configuration examples in this issue. No implementation files, entry points, tests, or concrete acceptance criteria are identified, so the scope and intended first deliverable need clarification before work can be considered done.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.