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.

Sign up for GitHub

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

Jump to bottom

Improve docs landing page #25

Closed
t92549 opened this issue Oct 10, 2023 · 1 comment · Fixed by #26
Closed

Improve docs landing page #25

t92549 opened this issue Oct 10, 2023 · 1 comment · Fixed by #26
Assignees
@t92549
Labels
documentation Improvements or additions to documentation

Comments

@t92549
Copy link
Contributor

t92549 commented Oct 10, 2023

Should include more details like:

  • what is gafferpy
  • overview for each section (generated, fishbowl, connector)
  • link to main docs
@t92549 t92549 added the documentation Improvements or additions to documentation label Oct 10, 2023
@t92549
Copy link
Contributor Author

t92549 commented Oct 10, 2023 •
edited
Loading

Also the README docs link should link to gafferpy docs not main docs

@t92549 t92549 self-assigned this Oct 10, 2023
@github-actions github-actions bot mentioned this issue Oct 10, 2023
Merged
t92549 added a commit that referenced this issue Oct 16, 2023
@t92549
Merge branch 'gh-25-docs-landing' of https://github.com/gchq/gafferpy …
e252d92 
…into gh-25-docs-landing
t92549 added a commit that referenced this issue Oct 17, 2023
@t92549 @GCHQDeveloper314
Gh-25: Improve docs landing page (#26)
d7cc3b3 
* Improve docs landing page

* Add docs building instructions

* Update README.md

Co-authored-by: GCHQDeveloper314 <94527357+GCHQDeveloper314@users.noreply.github.com>

* PR comments

---------

Co-authored-by: GCHQDeveloper314 <94527357+GCHQDeveloper314@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@t92549 t92549

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Gh-25: Improve docs landing page gchq/gafferpy
1 participant
@t92549