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

Documentation #148

Open
1 of 3 tasks
gsvgit opened this issue Jul 13, 2016 · 14 comments
Open
1 of 3 tasks

Documentation #148

gsvgit opened this issue Jul 13, 2016 · 14 comments

Comments

@gsvgit
Copy link
Member

gsvgit commented Jul 13, 2016

We need a good documentation.
We have own site.
There is an original documentation.
What we should do.

  • Create auto generated documentation.
  • Improve auto generated documentation (add more informative comments in code).
  • Migrate important parts (basic examples at most) of original documentation to our site.
@mhov
Copy link

mhov commented Apr 13, 2017

With codeplex shutting down soon, should someone take a snapshot of the original documentation?
https://blogs.msdn.microsoft.com/bharry/2017/03/31/shutting-down-codeplex/

@gsvgit
Copy link
Member Author

gsvgit commented Apr 18, 2017

@mhov Thanks for information! Yes, me should. I try to contact with team members. But seems that all members are inactive for a long time. Is it possible to download documentation if you are not a team member?

@gsvgit
Copy link
Member Author

gsvgit commented Apr 19, 2017

Good news from CodePlex team:

Currently document download is only available if you are a project owner. This is going to be the case until August when CodePlex becomes read-only.

When CodePlex is archived there will be links that can be used to get access to the project as a zip. That will include the documentation along with the other parts of the project so that anyone should be able to move the project to a new home. We have attempted to describe this in the CodePlex archive section of https://blogs.msdn.microsoft.com/bharry/2017/03/31/shutting-down-codeplex/

@chromanite
Copy link

Hi, am new in open source and was trying to get some projects on hand, was wondering if i could render any assistance in it?

@gsvgit
Copy link
Member Author

gsvgit commented Sep 1, 2017

Hi,
@minzhanfoo Yes, you can.
First, seems, that archive with documentation from codeplex will be available later. Read https://blogs.msdn.microsoft.com/bharry/2017/03/31/shutting-down-codeplex/ for details. When it well be available, you can help with documentation migration.

Also you can improve generated documentation (http://yaccconstructor.github.io/QuickGraph/reference/index.html). You can add some valuable comments in code for class and methods (especially if comments is empty now).

@briangabriel
Copy link

I have a copy of the CodePlex wiki converted to Github flavored markdown if you want it.

@grandconjuration
Copy link

@briangabriel Could you share that somehow? I cannot seem to find the original documentation anywhere...

@eloekset
Copy link

eloekset commented Aug 3, 2018

I've migrated the wiki content from the archived CodePlex project.

There's no way to send a PR against the wiki repo, so either you'll have to make me a contributor to this repo, or you'll have to manually pull in the commits from my custom "fork" of the wiki repo, here: https://github.com/eloekset/QuickGraph-Wiki/tree/feature/148-MigrateCodePlexWiki

Since I'm not able to see my own changes hosted as GitHub Wiki, I've obviously not tested how the content works. Basically I've just renamed the files that contained spaces to use dashes instead, to make links work. At least that seems to be needed when previewing files in VSCode.

@gsvgit
Copy link
Member Author

gsvgit commented Aug 27, 2018

@eloekset Thank you very much!
Results: https://github.com/YaccConstructor/QuickGraph/wiki

@gsvgit
Copy link
Member Author

gsvgit commented Aug 27, 2018

For all. What do you think about "synchronization" with autogenerated documentation? For example, description of AdjacencyGraph from wiki can be moved to autogenerated page It may done documentation more unified. Also, I think that other pats can be moved to github.io page

@gsvgit
Copy link
Member Author

gsvgit commented Aug 27, 2018

It may be useful to move (and create new) examples too (#177).

@eloekset
Copy link

eloekset commented Sep 2, 2018

I’ve updated all markdown files to use GitHub pages syntax for code blocks now. Still there are some things left to clean up after the port from CodePlex:

  • Merge Home, Documentation and User Manual somehow
  • Fix Russian translation by following GitHub pages localization patterns (if such exists)
  • Upload png files and fix broken references Example 1, Example 2 (more examples exist)
  • General improvement of the content, to make sure it’s up to date with this repository

Since I’m not on a PC at the moment, I’ve got limited editing capabilities ref this tweet 😋

Sorry, something went wrong.

@eosfor
Copy link

eosfor commented Feb 7, 2019

Hello colleagues, i've updated some parts of the wiki here, https://github.com/eosfor/Quickgraph.Wiki. Just did some cleanup, fixed markup and pics.

@gsvgit
Copy link
Member Author

gsvgit commented Feb 7, 2019

@eosfor Thank you! Merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants