linkedin / linkedin/eyeglass

Sitemap / IA

Open
#95 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation package:eyeglass
Dominant language
TypeScript
Stars
738
Forks
48
PR merge metrics
No merged PRs in 30d

Description

Start thinking about what content we're trying to capture and how best to express it to users.

Proposal:

```
Homepage (landing / upsell)
├─┬ Getting Started
│ ├── Getting started / installing Eyeglass
│ ├── Why Eyeglass
│ ├── Options
│ └── How Eyeglass works
├─┬ Eyeglass Modules
│ ├── What is an Eyeglass module
│ ├─┬ Authoring an Eyeglass module
│ │ ├── Exporting Sass (mixins, variables, partials, etc)
│ │ ├── Exporting custom Javascript functions
│ │ ├── Creating a new module with Yeoman generator
│ │ └── Converting an existing project to an Eyeglass module
│ └── Installing an Eyeglass module
├── Working with assets in Eyeglass
├─┬ Integration
│ ├── Pure node-sass
│ ├── With gulp.js
│ ├── With Grunt
│ ├── With Broccoli.js
│ └── With Ember CLI
├─┬ Troubleshooting
│ ├── Errors / warnings
│ ├── Debugging
│ └── Common issues
└── CHANGELOG
```

/cc @chriseppstein @xiwcx @una

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the proposed sitemap in the issue and compare its sections with the project's current documentation. Confirm which user journeys and content belong in the structure, then seek agreement on the information architecture. Done means the sitemap and resulting documentation sections have been approved.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, sass
Domain
content, design, documentation
Issue type
Documentation
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.