search

ForNeVeR / xaml-math

A collection of .NET libraries for rendering mathematical formulae using the LaTeX typesetting style, for the WPF and Avalonia XAML-based frameworks
MIT License
639 stars 100 forks source link

Documentation for contributors #43

Open gsomix opened 7 years ago

ForNeVeR commented 7 years ago

Clarify, please. What kind of documentation do our contributors need?

ForNeVeR commented 6 years ago

Okay, I'll try to elaborate myself.

We need sort of architectural document that will describe the current structure of the project. Major topics include:

For now, I have knowledge for most of the topics above with notable exception of XML files (I've no idea how are they created but we're trying to research it more), so I could become the main device behind documenting the stuff.

I suggest myself and other potential contributors to make small PRs for each of the topics (because it'll be easier to prepare and review). We'll close this task after all topics listed above are covered by the documentation. It's advisable to document new features as they come (although that shouldn't be a mandatory requirement for contributors to document it themselves).

charlesroddie commented 6 years ago

FYI I'm currently rewriting this in F#, as a personal project to be able to understand the code and subsequently make the TeX editable. I don't know if I will succeed as the code is at first glance very OO, cyclic and imperative. But there may be a linear structure underlying it. If I do have some success you may be interested as I notice that everyone contributing seems to know F#. Help would be much appreciated as I am likely to have a lot of questions, mostly about the basic structure and meanings of the objects in your list, but also about some ideas for simplification.

ForNeVeR commented 6 years ago

@charlesroddie I've decided to move the discussion about F# port to another issue: #111.

And feel free to ask questions disregard we decide to port the code to F# or not; in any case, I'll be happy to (try to) answer any your questions about the project code.

B3zaleel commented 6 years ago

If the documentation were to be created(or initialized), would you want it as a PDF, html or rst file?.

gsomix commented 6 years ago

@B3zaleel I'd prefer markdown.

ForNeVeR commented 5 years ago

We have already started writing the documentation in markdown format. So, yeah, it's definitely a good choice for a project hosted on GitHub.