Docs Missing Pages

[AngelMunoz]

With the new website sources in place, we can start improving the Avalonia.FuncUI docs
so far we have a few pages

• Guides
  • Home
  • Basic Template
  • Full Template
  • Quickstart Template
  • Views And Attributes
  • Unit Testing Avalonia.FuncUI Apps

We have a couple of candidates that are not in the list yet

• Form Validation
• Communication between child "views"
  (Although this is more of an Elmish question, I believe it will keep popping up)
• Styling
  • F#
  • XAML resource

We also have some control pages already with basic examples these can be improved later, the main goal is to have basic examples for each control supported by Avalonia.FuncUI

• Controls
  • Border
  • Button
  • Calendar
  • CheckBox
  • DatePicker
  • Expander
  • Menu
  • NativeMenu
  • RadioButton
  • TabControl
  • StackPanel
  • TextBox

Missing (taken from the Avalonia docs website):

• Controls
  • Canvas
  • Carousel
  • ComboBox
  • ContentControl
  • ContextMenu
  • Decorator
  • Grid
  • GridSplitter
  • Image
  • ItemsControl
  • ItemsRepeater
  • LayoutTransformControl
  • ListBox
  • Panel
  • ProgressBar
  • RepeatButon
  • ScrollBar
  • ScrollViewer
  • Separator
  • Slider
  • ToolTip
  • TreeView
  • UserControl (HostControl)
  • Window (HostWindow)
  • WrapPanel

If there's an item missing from the list let me know

[FoggyFinder]

Suggestion:

Add page about styling.

It's not obvious how to add one.

For example, it took some time for me to understand that for adding simple style I have to write

let styles = Styles()
let style = Style(fun s -> s.OfType<TextBlock>().Class(":pointerover"))
let setter = Setter(TextBlock.ForegroundProperty, brush)
style.Setters.Add setter
styles.Add style
styles

Also I wrote .Class("pointerover") at first.

[AngelMunoz]

@FoggyFinder Indeed this is also needed (will add it to the list) though I don't know much about the styling part any help would be appreciated

[smolck]

So I'd like to help out here where I can, and I was wondering about making a new page for a control, what sort of guidelines I should follow? Any tips/pointers on making a new page or should I just write up a new doc based on the other ones that already exist and PR it?

[AngelMunoz]

Thanks for the interest @smolck we really appreciate it.

You can follow the README instructions and you can base your work on the existing ones.

Ideally, you would like to link Avalonia Documentation (either Control Reference or the Type's API)
like here and here then write a couple of examples on how to set properties or use the controls themselves.

From there anything unchecked on the list you want to pick feel free to do so 😁

PS: I was forgetting that @NicoVIII recently added a .editorconfig to the repository please ensure your editor supports it

if you have doubts or comments you can ping me on gitter also

[smolck]

Thanks for the interest @smolck we really appreciate it.

No problem! Happy to help 😁

You can follow the README instructions and you can base your work on the existing ones.

Ideally, you would like to link Avalonia Documentation (either Control Reference or the Type's API)
like here and here then write a couple of examples on how to set properties or use the controls themselves.

From there anything unchecked on the list you want to pick feel free to do so 😁

Thanks! That’ll get me started!

PS: I was forgetting that @NicoVIII recently added a .editorconfig to the repository please ensure your editor supports it

Are there any plugins to add to VSCode to make this work, or does VSCode support that by default?

if you have doubts or comments you can ping me on gitter also

Will do! Thanks for the quick reply!

[NicoVIII]

VScode does not support it out-of-the-box as far as I know, but there is this extension one can use:
https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig

If editor specific code is okay inside the repository we could add extension recommendations to a .vscode/extensions.json file.