rapidsai / rapidsai/cugraph-docs

New Docs look and pages

Open
#13 0 comments 0 reactions 1 assignee View on GitHub

@acostadon is already working on this.

Since Jul 13, 2023.

Dominant language
Shell
Stars
5
Forks
23
Avg merge
13h 44m
Merged PRs (30d)
9

Description

Create the new look of the documentation area and fill in all the needed pages

Navigation Outline

  • Overview
  • Installation
  • Tutorials
  • Graph
  • Developer Resources
    • API
      • Python
      • C
    • Developer Guides
  • Releases
  • Glossary
  • Reference
### Create the new structure and migrate existing API pages over
- [ ] https://github.com/rapidsai/cugraph/issues/3297
- [x] Migrate cuGraph Python API docs
- [x] Migrate cugraph-dgl API docs
- [x] Migrate cugraph-pyg docs
- [x] Migrate cugraph-service-clinet API docs
- [x] Migrate cugraph-service-server API docs
### Develop Tutorials 
- [ ]  How-To list 
- [ ] Basic use of cuGraph, on the page 
- [ ] Property graph with analytic flow 
- [ ] GNN – model building 
- [ ] cuGraph Service – client/server setup and use (ucx)
- [ ] MNMG Graph – dask, rmm basics and examples 
- [ ] Pylibcugraph – why and how
- [ ] Cugraph for C, C++ users 
- [ ] Use of nvidia-smi with cugraph 
- [ ] https://github.com/rapidsai/cugraph/issues/3426
- [ ] Blog List  
- [ ] Community Resources 
- [ ] https://github.com/rapidsai/cugraph/issues/3226
- [ ] https://github.com/rapidsai/cugraph/issues/3072
- [ ] https://github.com/rapidsai/cugraph-pg/issues/18
- [ ] https://github.com/rapidsai/cugraph-docs/issues/25
- [ ] https://github.com/rapidsai/cugraph-docs/issues/14
- [ ] https://github.com/rapidsai/cugraph-docs/issues/28
- [ ] https://github.com/rapidsai/cugraph/issues/2773
- [ ] https://github.com/rapidsai/cugraph/issues/2767
- [ ] https://github.com/rapidsai/roadmap/issues/443
- [ ] https://github.com/rapidsai/cugraph-docs/issues/26
- [ ] https://github.com/rapidsai/graph_dl/issues/70
### Graph Support Section
-   [x] Graph Algorithms
- [ ]     Graph Types supported and unsupported graph types, links to API
  - [ ]     Algorithms – main algo page, Mirror of current algorithm toc with more
    - [ ]     Mirror of current algorithms content with more
-   [ ] Functions --  graph functions
- [ ]     Operations on graphs and links to API, relevant how-to’s
-   [x] Multi-GPU Support basics of multi-GPU support
-   [ ] DASK references
-   [ ] RMM References
-   [ ] Compatibility
-   [ ] networkX
-   [ ] GNN Support
-   [ ] DGL
-   [ ] PyG
-   [ ] cuGraphops
-   [ ] Wholegraph
-   [ ] Data Stores
-   [ ] Property Graph
-   [ ] Feature Store
-   [ ] Knowledge Store
-   [ ] cuGraph Service
-   [ ] client
-   [ ] service
-   [ ] multi-gpu setup
- [ ] https://github.com/rapidsai/cugraph/issues/3031
- [ ] https://github.com/rapidsai/cugraph/issues/3030
- [ ] https://github.com/rapidsai/cugraph-docs/issues/23
- [ ] https://github.com/rapidsai/cugraph/issues/3024
- [ ] https://github.com/rapidsai/cugraph/issues/3023
- [ ] https://github.com/rapidsai/cugraph-docs/issues/16
- [ ] https://github.com/rapidsai/cugraph-docs/issues/21
- [ ] https://github.com/rapidsai/cugraph-docs/issues/18
- [ ] https://github.com/rapidsai/cugraph-docs/issues/15
- [ ] https://github.com/rapidsai/cugraph-docs/issues/1
- [ ] https://github.com/rapidsai/cugraph-docs/issues/10
### Developer Resources
- [ ]     API 
- [ ]     Python 
- [ ]     Cugraph 
- [ ]     Pylibcugraph 
- [ ]     Cugraph-service 
- [ ]     cugraphops 
- [ ] https://github.com/rapidsai/cugraph/issues/3406
- [ ]     Wholegraph 
- [ ]     Cugraphops 
- [ ]     libcuGraph 
- [ ]     libcugraph_c 
- [ ]     Development/Contribution  
- [ ]     Style Guide (link to Rapids) 
- [ ] https://github.com/rapidsai/cugraph/issues/3213
- [ ] https://github.com/rapidsai/cugraph/issues/3141
- [ ] https://github.com/rapidsai/cugraph/issues/3133
- [ ] https://github.com/rapidsai/cugraph-docs/issues/24
- [ ] https://github.com/rapidsai/cugraph/issues/3340
- [ ] https://github.com/rapidsai/graph_dl/issues/71
### Release Section
- [ ] Release and Change history
- [ ] Roadmap
### Glossary Section
- [ ] create the glossary 
### References Section
-   [ ]   Datasets
-   [ ]   Algorithm papers
-   [ ]   licenses
-   [ ] https://github.com/rapidsai/cugraph-docs/issues/12
### Refactor GitHub Pages
- [ ] https://github.com/rapidsai/cugraph/issues/2500
### General
- [ ] https://github.com/rapidsai/cugraph/issues/2037
- [ ] https://github.com/rapidsai/graph_dl/issues/117
### cugraph-ops
- [ ] https://github.com/rapidsai/cugraph-ops/issues/462

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.