---
# System prepended metadata

title: GitHub Readme / Wiki updates
tags: [' github', meeting-notes]

---

---
robots: nofollow, noindex
tags: meeting-notes, github
---

# GitHub Readme / Wiki updates

- https://github.com/microsoft/fluentui/blob/master/README.md
- https://github.com/microsoft/fluentui/wiki
- https://fluentsite.z22.web.core.windows.net/ (https://aka.ms/fluent-ui)

## Goals
- Don't confuse people coming here (v0/v7/web components)

## Main tasks
- [x] Rework Readme to describe
    - [x] Northstar
    - [x] React
    - [x] Web Components
- [ ] Move current readme into /packages/react/ folder
- [ ] Add readme for office-ui-fabric-react
- [ ] Rename packages and folders
    - [x] [react](https://github.com/microsoft/fluentui/tree/master/packages/react)
    - [ ] fluentui -> [react-northstar](https://github.com/microsoft/fluentui/tree/master/packages/fluentui)
    - [x] [web-components](https://github.com/microsoft/fluentui/tree/master/packages/web-components)
- [ ] Add top-level CONTRIBUTING.md super concise that links to react, react-northstar, and web-components specific CONTRIBUTING.md docs.
- [ ] Propose a wiki IA hierarchy
    - [x] Add in proposed structure
    - [ ] Make sure old wiki articles can either fit or go into an Archive section

## Other Things to do
- Banner on v0 doc page explaining relation between v0 and v7
- Update intro page on react-northstar
- ~~Update: https://github.com/microsoft/fluentui/wiki/FAQ---Fabric-and-Stardust-to-Fluent-UI~~
    - Going to leave this as is as a point in time thing
    
## Out of scope
- Updating https://developer.microsoft.com/en-us/fluentui

## Actual Readme

# Fluent UI Web

[![Build Status](https://img.shields.io/azure-devops/build/uifabric/fabricpublic/84/master?style=flat-square)](https://dev.azure.com/uifabric/fabricpublic/_build/latest?definitionId=84&branchName=master) ![GitHub contributors](https://img.shields.io/github/contributors/microsoft/fluentui?style=flat-square) ![GitHub top language](https://img.shields.io/github/languages/top/microsoft/fluentui?style=flat-square) [![Twitter Follow](https://img.shields.io/twitter/follow/fluentui?logo=twitter&style=flat-square)](https://twitter.com/FluentUI?ref_src=twsrc%5Etfw)

The Fluent UI web ecosystem is home to 3 projects.

TODO: add images for used by, uber list for main README and smaller lists for each individual README.
- Web components: ...
- Northstar: Teams, ...
- React: Office, ...

|  | React | React Northstar | Web Components |
|---|---|---|---|
| **Overview** | Mature, refreshing with new concepts from react-northstar.  | Newer, has concepts we're iterating on. | Web Component implementation of Fluent UI. |
| **Info** | README.md | README.md | README.md |
| **Quick Start** | Quick Start | Quick Start | Quick Start |
| **Docs** | aka.ms/fluentui-react | aka.ms/fluentui-react-northstar | aka.ms/fluentui-web-components |
| **NPM** | `@fluentui/react` | `@fluentui/react-northstar` | `@fluentui/web-components` |
| **Version** | [![npm version](https://img.shields.io/npm/v/@fluentui/react?style=flat-square)](https://www.npmjs.com/package/@fluentui/react) | [![npm version](https://img.shields.io/npm/v/@fluentui/react-northstar?style=flat-square)](https://www.npmjs.com/package/@fluentui/react-northstar) | [![npm version](https://img.shields.io/npm/v/@fluentui/web-components?style=flat-square)](https://www.npmjs.com/package/@fluentui/web-components)  |
| **Issues** | [![GitHub issues by-label](https://img.shields.io/github/issues/microsoft/fluentui/Fluent%20UI%20react?label=issues&style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Fluent+UI+react%22) | [![GitHub issues by-label](https://img.shields.io/github/issues/microsoft/fluentui/Fluent%20UI%20react-northstar?label=issues&style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Fluent+UI+react-northstar%22) | [![GitHub issues by-label](https://img.shields.io/github/issues/microsoft/fluentui/web-components?label=issues&style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22web-components%22)|

>The goal of these projects is to dedupe and increase interopability over time. Why are there two React versions? See the [FAQ on Fabric and Stardust](https://github.com/microsoft/fluentui/wiki/FAQ---Fabric-and-Stardust-to-Fluent-UI)

## Roadmap

Each project within the Fluent UI ecosystem has its own roadmap.  Here, you can find a high-level roadmap for the entire effort itself.

[LINK](TODO)


## License
All files on the Fluent UI Web GitHub repository are subject to the MIT license. Please read the License file at the root of the project.

Usage of the fonts and icons referenced in Fluent UI Web is subject to the terms of the assets license agreement.

***

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

# Appendix

## Other interesting badges
![npm type definitions](https://img.shields.io/npm/types/@fluentui/react-northstar?style=flat-square)

![LGTM Grade](https://img.shields.io/lgtm/grade/javascript/github/microsoft/fluentui?style=flat-square)

![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/microsoft/fluentui?style=flat-square)

![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/@fluentui/react?style=flat-square)

![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/@fluentui/react-northstar?style=flat-square)

![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/@fluentui/web-components?style=flat-square)

[![GitHub issues by-label](https://img.shields.io/github/issues/microsoft/fluentui/Fluent%20UI%20react?style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Fluent+UI+react%22)

[![GitHub issues by-label](https://img.shields.io/github/issues/microsoft/fluentui/Fluent%20UI%20react-northstar?style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Fluent+UI+react-northstar%22)


[![GitHub issues by-label](https://img.shields.io/github/issues/microsoft/fluentui/web-components?style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22web-components%22)


## Wiki IA
:::info
A lot of this structure was lifted from VS Code's wiki
:::

Working Principles: 

We have *one* wiki that covers: 

2 main projects in the repo that publish 3 packages:
1. React project (leaning the towers so this becomes one)
    - `@fluentui/react`
    - `@fluentui/react-northstar`
2. Web Components
    - `@fluentui/web-components`   

Each project will have a common set of wiki acticles

Each project will have their own unique set of wiki acticles that can be under a project specific section

__________

### What's New (CY2020)
* React
    * [FAQ - Fabric and Stardust to Fluent UI]()
* Web-Compnents
    * [FAQ - What is @fleuentui/web-components]()

### Project Management
* React
    * [Roadmap]() - this will include `react`,  `react-northstar`, and `react-next`
    * [Iteration Plans]()
    * [Release Process]()
    * [Backlog]() - this can be joint or separate for `react`, `react-northstar`, `react-next ` etc.
* Web Components
    * [Roadmap]()
    * [Iteration Plans]()
    * [Release Process]()
    * [Backlog]()
* Issue Tracking
    * [Issue Triage Process]()
    * [Issue Grooming]()

### Contributing
* [How to Contribute]()
* [Submitting Bugs and Suggestions]()
* [Contributor License Agreement]()
* [Feedback Channels]()
* React
    * [Enviroment Setup]()
* Web Components
    * [Enviroment Setup]()

### Documentation
* API and Examples
    * [Fluent UI React]()
    * [Fluent UI React Northstar]()
    * [Fluent UI Web Components]()

### References
* React
    * [Browser Support]()
    * [Accessibility Test Matrix]()
* Web Components
    * [Browser Support]()
    * [Accessibility Test Matrix]()

### Archive
* Office UI Fabric
:::warning
TODO: add in legacy wiki articles around Fabric v5, v6, etc.
:::