neo4j-documentation / neo4j-documentation/docs-ui

Remove or replace prompt from the copy text in source block

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
5
Forks
26
Avg merge
1h 49m
Merged PRs (30d)
2

Description

Currently, we are using the following prompts in the documentation:

neo4j-home> echo "foo"
$ echo "foo"
neo4j> call dbms.cluster.overview() yield addresses, role;

(on Neo4j shell)

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.

Research direction

Review the documentation source blocks containing the neo4j-home> and $ prompts, along with the Neo4j shell example using neo4j>. Decide whether each prompt should be removed or replaced consistently; the work is done when the affected examples no longer use the misleading prompts.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.