Skip to content
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

Docs/website #112

Open
wants to merge 30 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
40d8d53
docs: Hello World full tutorial example.
pattobrien Jan 15, 2023
5fa5d1b
docs: Hello world code snippets.
pattobrien Jan 16, 2023
063379c
docs: Application layer example code.
pattobrien Jan 16, 2023
40fc2c4
docs: Bloc feature-first snippets.
pattobrien Jan 17, 2023
b45ce01
docs: Delete placeholder tutorial pages.
pattobrien Jan 17, 2023
a780840
test: Fixed sourceLocationFromJson
pattobrien Jan 17, 2023
783e56f
docs: Index page text changes.
pattobrien Jan 19, 2023
033403a
docs: Undraw images, blue style for entire site.
pattobrien Jan 19, 2023
6ac6bcb
docs: Discord invite link.
pattobrien Jan 19, 2023
5e93820
docs: Introduction page and tutorial page.
pattobrien Jan 19, 2023
8ef16f2
docs: Initial setup CLI image, removed old usage guide placeholders.
pattobrien Jan 19, 2023
ac7307b
docs: Removed docusaurus nav bar icon.
pattobrien Jan 19, 2023
418ff7c
docs: Usage rewording.
pattobrien Jan 19, 2023
b3356f5
docs: Add gitignore for snippets.
pattobrien Jan 19, 2023
35fb54c
docs: Delete log files.
pattobrien Jan 19, 2023
1902d69
docs: Make unfinished tutorials private.
pattobrien Jan 19, 2023
694b151
docs: Hello world completed tutorial.
pattobrien Jan 19, 2023
929be37
docs: Bloc file structure guide cleanup.
pattobrien Jan 19, 2023
5e2266f
feat: generateSnippet shows particular snippets.
pattobrien Jan 21, 2023
d46c681
feat: TypeChecker core concepts.
pattobrien Jan 21, 2023
a34fa16
docs: TypeChecking finalized docs.
pattobrien Jan 22, 2023
ab74851
docs: Rule Creation table with available sidecar_lints.
pattobrien Jan 22, 2023
a6300d9
docs: Hello world tutorial fixes.
pattobrien Jan 22, 2023
d9a51f4
docs: Feature-first project structure tutorial.
pattobrien Jan 22, 2023
d83b047
Merge branch 'master' into docs/website
pattobrien Jan 22, 2023
5781be5
chore: Upgrade to Sidecar v0.1.0-dev.21.
pattobrien Jan 22, 2023
fccac33
docs: Testing documentation.
pattobrien Jan 23, 2023
4368174
docs: Integration Testing documentation.
pattobrien Jan 23, 2023
b928da7
docs: Warning message on intro page.
pattobrien Jan 23, 2023
45f6970
test: Test change to see if codecov is triggered.
pattobrien Oct 7, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion website/sidecar/docs/concepts/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"label": "Core Concepts",
"position": 3
"position": 3,
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test comment

"link": {
pattobrien marked this conversation as resolved.
Show resolved Hide resolved
"type": "generated-index"
}
}
14 changes: 9 additions & 5 deletions website/sidecar/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,22 @@
sidebar_position: 1
title: Introduction
---
:::caution

Sidecar is currently an experimental package and is not recommended to be used to create lints for production projects.

> NOTE: This site is an active, high-priority project to help get you and others started with creating your own lint rules.
If there's any trouble you have with using Sidecar or a Sidecar-based rule package (like design_system_lints), your
feedback would be greatly appreciated in the [Discord channel](https://discord.gg/YhFS6V26Vg).
However, if you'd still like to proceed and create your own lints, these docs can certainly help get you started.
For any additional questions that you have, dont hesitate to reach out on [Discord](https://discord.gg/YhFS6V26Vg).

:::
## Getting Started

Sidecar is a framework for creating custom lint and quick fix rules for Dart and Flutter projects.

For information on how to set up a rule package in order to display lints throughout your codebase or CLI, check out the [usage guides](category/usage-guides)
for setup steps and troublshooting tips.

If you want to create your own lint rules, we've created several [tutorials](category/tutorials) that break down the process of doing so.
But before diving in to the tutorials, its highly recommended that you understand the core concepts and usage guidelines of both
sidecar and package:analyzer.
But before diving in, its highly recommended that you fully understand the [core concepts](category/core-concepts) and usage guides of both
sidecar and [package:analyzer](https://pub.dev/packages/analyzer).