search

LayoutFarm / HtmlRenderer

C# HTML Layout and HTML Rendering Engine
http://layoutfarm.github.io/HtmlRenderer/
Other
185 stars 40 forks source link

Documentation Project:) #7

Open prepare opened 7 years ago

prepare commented 7 years ago

First I'm not a native English speaking person. so you can correct it where it is wrong grammar/ wrong intention or not proper.

You CAN HELP ME create the topics that you want to know. so I will create a description for it

:)

ArsenShnurkov commented 5 years ago
  1. Please create gh-pages branch in this repository ( https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/ )
  2. Please add intro page to that branch, and deploy it to CDN
  3. Please edit URL field in project main page to point to that site on CDN (for example please look at this project - https://github.com/klange/ponyos , it have a link to it's "homepage" right next to the project's description, between "< > Code" tab and hashtags.)
  4. Please provide instructions on how to join to development discussion (mailing list, xmpp conference name, or something)
prepare commented 5 years ago
ArsenShnurkov commented 5 years ago

url field from point 3 was not added, so one can navigate from site to github, but can't navigate in opposite direction.

  1. i don't see "gh-pages" branch in the repository linked from that site, so I don't understand, how to contribute content to it via PRs
ArsenShnurkov commented 5 years ago

My remaining questions about this project are:

prepare commented 5 years ago

How to change the website of project, what is the process for this?

=> the current project's website is auto-generated page from GitHub's tool. It was generated from readme.md

What are the dependencies of the project?

=> It needs PixelFarm and Typography see detail in https://github.com/PaintLab/PixelFarm/issues/37

What is the testing process?

=> I tested it with some examples in test/example folder. No systematic test now :(

prepare commented 5 years ago

Contributor guideline => see Notes on my intentions

ArsenShnurkov commented 5 years ago

So, what if I want to add instructions about building this thing under portage? I need to edit readme file and provide pictures. If there were a separate branch, I think the separate branch would be more convenient than editing the readme file.

About dependencies, i was asked about other dependencies, not only between parts of project. I remember that somewhere was dependencies even from GDI+.

prepare commented 5 years ago

  1. I invite you here => https://paintlab.github.io/pxdev/ ( 1.1 since it should be a start point for building the HtmlRenderer, 1.2 it is a lightwight repo for building and documentation. 1.3 after it is settle I will bring the content to here)

  2. I will recheck the dependencies again esp native dll(s)

prepare commented 5 years ago

I invite you as a collaborator of https://github.com/PaintLab/pxdev check your e-mail for an invitation. Free free to write and edit the repo.

ArsenShnurkov commented 5 years ago

I am looking at some unrelated project website (https://www.npgsql.org/doc/), and see the label "gitter:join chat" - gitter. What do you think about using that site (gitter.im) for communications? Which channel to join?

when I am trying to join https://gitter.im/PaintLab/pxdev it says me: "If you're looking to access a private repository, you will need to upgrade your GitHub authentication to allow us to access the list of your private repositories." and when I update github's authentification, gitter.im says "404. This is not the chat you're looking for. Sorry. :(" meaning that there is no such chat (that happens after accepting the invitation)

prepare commented 5 years ago

I click your link now https://gitter.im/PaintLab/pxdev , it says the same

  1. This is not the chat you're looking for. Sorry. :(

I'm not ready for any real-time chat because I can't read that chat and/or see notification all the time. => other users still need to wait for reply at the rate I reply the GitHub issues/notification.

ArsenShnurkov commented 5 years ago

chat have difference with issues it that aspect that anyone feel easier to ask questions, which are not issues by itself. Actually we are chatting here in issues, and (in my feeling) this is not what the issues are destined for.

Even if you will answer rarely, it will allow to other users to ask questions. It's nothing wrong to not answer immediately. That chat keeps the history, and notify via email about new messages if you want.

The chat is the road for users of community to interoperate between themselves. I think that you need to create that chat on the gitter.im site.

prepare commented 5 years ago

OK, Lets create a chat room.

prepare commented 5 years ago

Try this ... https://gitter.im/paintlab_pxdev/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link