caolan / caolan/highland

example template

Open
#204 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
JavaScript
Stars
3.4k
Forks
145
PR merge metrics
No merged PRs in 30d

Description

I propose the following in order to build the example section of the website
- add an example directory
- each subdir of example would be an example
- each example dir would contain
- an index.js file that would be browserified. There should be a way to introspect the example name, + category + the list of highland transform that this example examplifies (this should probably be in the index.js documentation)
- an index.html file that would give life to the example ; index beeing built from a template
- add 2 examples
- build an example index
- build an example index for each category
- link the example index from the main page + add, for each transform, the list of examples that use the transform

this should re-use the architectural pattern that has already been done for the website (templating system, modules, ..) and integrated in the same grunt rule.

this would work well for browser based examples. It would be a + if examples could also be launched server side easily, but this seems less important for the evangelism of the project.

if anyone feels like working on it, or wants to modify this proposal, this issue is very open ;-)

Contributor guide

Open the contributing guide

Research direction

Start by reading the existing website templating system, modules, and the Grunt rule mentioned in the proposal. Then review how the main page and transforms are represented; the work would be complete when the example directory structure, browser examples, category indexes, and links from the main page and transforms are defined and integrated.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.