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

chore: docs in the monorepo #1128

Merged
merged 430 commits into from
Jul 20, 2023
Merged

chore: docs in the monorepo #1128

merged 430 commits into from
Jul 20, 2023

Conversation

ludamad
Copy link
Collaborator

@ludamad ludamad commented Jul 20, 2023

Description

Resolves #1085. Documentation should be owned more by engineers, right now
it's hard to iterate the examples easily. As well we want to avoid code-rot
by automatically updating examples.

History has been rewritten to maintain valid issue and PR links.

Redoing #1120

EDIT FOR POSTERITY: Process was similar to the below (although this exact script was for barretenberg):

set -xue
# Clone both repositories
git clone https://github.com/AztecProtocol/barretenberg.git
git clone https://github.com/AztecProtocol/aztec-packages.git

# Enter barretenberg repository and filter it
cd barretenberg
git filter-repo --to-subdirectory-filter barretenberg
git filter-repo --message-callback """
  import re

  def replace_hash_with_url(text):
       url_format = 'https://github.com/AztecProtocol/barretenberg/issues/{}'
       # the regular expression pattern r'#(\d+)' matches a '#' followed by one or more digits (\d+)
       return re.sub(r'#(\d+)', lambda match: url_format.format(match.group(1)), text)
  message = message.decode('utf-8') # Decode from bytes to string
  message = message.replace('(#', '(https://github.com/AztecProtocol/barretenberg/pull/')
  message = message.replace('Merge pull request #', 'Merge pull request https://github.com/AztecProtocol/barretenberg/pull/')
  return replace_hash_with_url(message).encode('utf-8') # Encode back into bytes
"""

# Enter aztec-packages repository
cd ../aztec-packages

# Create a new branch for the combined history
git checkout -b combined_history

# Add barretenberg as a remote and fetch it
git remote add barretenberg ../barretenberg
git fetch barretenberg

# Merge the histories, preserving the directory structure
git merge --no-commit --allow-unrelated-histories barretenberg/master

# Commit the changes
git commit -m "chore: barretenberg in the monorepo" -m "See #1126 for motivation."

Checklist:

  • I have reviewed my diff in github, line by line.
  • Every change is related to the PR description.
  • I have linked this pull request to the issue(s) that it resolves.
  • There are no unexpected formatting changes, superfluous debug logs, or commented-out code.
  • The branch has been merged or rebased against the head of its merge target.
  • I'm happy for the PR to be merged at the reviewer's next convenience.

critesjosh and others added 26 commits May 2, 2023 12:03
…abstractions-extension

Clarify on communication abstractions
* feat(batch-insertion): init commit

* fix: cpp -> auto

* fix: update image links

* fix: various minor formatting

* fix: latex fixes

* fix: some review edits

* fix: latex tests

* fix: latex

exp

exp

exp

exp

* fix: 20 formatting?

* fix: update legend

* fix: diagram colours
Add sequencers/provers updates, link to barretenberg's source code, and update the smart contracts description
Implements #1085. Aims to make docs more accessible during engineer feature development.
@ludamad ludamad force-pushed the ad/chore/docs-monorepo branch from 34361a2 to d582d80 Compare July 20, 2023 23:06
@ludamad ludamad merged commit fe5a561 into master Jul 20, 2023
@ludamad ludamad deleted the ad/chore/docs-monorepo branch July 20, 2023 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Bring live documentation in the repo