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

Link key features #1805

Closed
chschroeder opened this issue Oct 27, 2022 · 1 comment
Closed

Link key features #1805

chschroeder opened this issue Oct 27, 2022 · 1 comment
Assignees
@chschroeder @davidberenstein1957
Labels
type: enhancement Indicates new feature requests

Comments

@chschroeder
Copy link
Contributor

Hey, I have a small but maybe useful suggestion: In the README.md file, of all things your "Key Features" do not link to the respective concepts in the docs. Maybe there is a reason against this, then consider this withdrawn. Otherwise, this is easy to do and much nicer to navigate, especially for new users.

I can provide a PR with suggestions if you like.

Is your feature request related to a problem? Please describe.

For example, this...
Auswahl_397

Describe the solution you'd like

...could look like this:
Auswahl_396

I was not sure which documentation page to link in the middle, otherwise each line would have had at least one link.
@chschroeder chschroeder added the type: enhancement Indicates new feature requests label Oct 27, 2022
@dvsrepo
Copy link
Member

dvsrepo commented Oct 28, 2022 •
edited

@chschroeder This is such a great suggestion! We would be glad to receive a PR!

chschroeder added a commit to chschroeder/argilla that referenced this issue Oct 28, 2022
@chschroeder
docs: Link key features (argilla-io#1805)
7a65451 
Signed-off-by: Christopher Schröder <chschroeder@users.noreply.github.com>
davidberenstein1957 added a commit that referenced this issue Nov 2, 2022
@chschroeder @davidberenstein1957
docs: Link key features (#1805) (#1809)
4c83604 
* docs: Link key features (#1805)

Signed-off-by: Christopher Schröder <chschroeder@users.noreply.github.com>

* corrected for typo

Signed-off-by: Christopher Schröder <chschroeder@users.noreply.github.com>
Co-authored-by: Christopher Schröder <chschroeder@users.noreply.github.com>
Co-authored-by: David Berenstein <david.m.berenstein@gmail.com>
davidberenstein1957 added a commit that referenced this issue Nov 3, 2022
@frascuchon @davidberenstein1957
@dvsrepo @pre-commit-ci @chschroeder
Docs/final docs 1.x revision (#1796)
e880100 
* docs:
- removed rubrix from readme quickstart
- removed rubrix from docs quickstart

* removed Rubreix from quickstart example

* docs:
- added hover behavior

* docs:
- removed usage of rubrix from libraries example

* docs:
- updated .gitignore to include tasks
- updated .css to improve hover behaviour

* docs:
- adde terminology page
- updated demo video
- updated github readme

* docs:
- added tiles for deepdives
- added tiles for tutorials

* docs: some enhancements

* docs: remove discussion linkl

* docs: test removing what is argilla to avoid duplicated navigation

* docs: Update README links linkedin and twitter (#1797)

* docs: fix quickstart comments

* docs: add general message instead of wip

* docs: redo partially mlops steps

* [pre-commit.ci] pre-commit autoupdate (#1798)

updates:
- [github.com/psf/black: 22.8.0 → 22.10.0](psf/black@22.8.0...22.10.0)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* chore: set next dev version

* docs: small bug fixes and initial new set-up for deepdives

* docs: renamed text2text->textgeneration, added guides for MLOps, resolved small typo´s and bugs.

* Create docker-compose.yaml

* docs: remove duplicate index, add documentation on deepdives for steps and some techniques

* docs: added additional techniques sections, added additional picture for filtering, replaced github names for argilla

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update README.md

* docs: resolved miss-direction and old naming in README.md

* docs: corrected for iframe

* docs: change iframe for mp4

* docs: added black formatting to notebooks

* docs: Link key features (#1805) (#1809)

* docs: Link key features (#1805)

Signed-off-by: Christopher Schröder <chschroeder@users.noreply.github.com>

* corrected for typo

Signed-off-by: Christopher Schröder <chschroeder@users.noreply.github.com>
Co-authored-by: Christopher Schröder <chschroeder@users.noreply.github.com>
Co-authored-by: David Berenstein <david.m.berenstein@gmail.com>

* docs: added final deepdives, simplified headers.

* docs: corrected for mis-placed tutorial

* docs: added office hour Argilla button

* docs: updated calendly office hours setting

* Revert "Merge branch 'develop' into 'docs/final-docs-1.x-revision'"

This reverts commit 3407082, reversing
changes made to 4835ab8.

* Merge branch 'main' into 'docs/final-docs-1.x-revision'

Signed-off-by: Christopher Schröder <chschroeder@users.noreply.github.com>
Co-authored-by: david <david.m.berenstein@gmail.com>
Co-authored-by: dvsrepo <daniel@recogn.ai>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christopher Schröder <6340318+chschroeder@users.noreply.github.com>
Co-authored-by: Christopher Schröder <chschroeder@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chschroeder chschroeder

@davidberenstein1957 davidberenstein1957

Labels
type: enhancement Indicates new feature requests
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dvsrepo @chschroeder @davidberenstein1957