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

[Docs] Bring live documentation in the repo #1085

Closed
3 tasks done
ludamad opened this issue Jul 17, 2023 · 1 comment · Fixed by #1120 or #1128
Closed
3 tasks done

[Docs] Bring live documentation in the repo #1085

ludamad opened this issue Jul 17, 2023 · 1 comment · Fixed by #1120 or #1128

Comments

@ludamad
Copy link
Collaborator

ludamad commented Jul 17, 2023 •
edited
Loading

Anything being iterated on and with the potential to go out-of-date should be brought into the monorepo. It can either be in a separate docs/ tree (allows for easy mirroring), or if it makes sense, as part of the main code, but not triggering CI rebuilds. Conceptually they should be seen as tightly coupled. If you think you have a breaking change, you should be checking the docs for stuff to update.

Soapboxing: The idea is that if people spend extra effort here it's ultimately for the best as our external UX is a major thing we're shipping, we don't plan to build huge parts of Aztec so a code-over-the-hill approach will not work.

Tasks
Preview Give feedback
  1. chore: docs in the monorepo #1128
  2. chore: add .gitrepo file to docs #1130
  3. feat(ci): mirror docs repo #1131
@github-project-automation github-project-automation bot moved this to Todo in A3 Jul 17, 2023
ludamad added a commit that referenced this issue Jul 19, 2023
@ludamad
chore: Bring live documentation in the repo
be770f3 
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.
ludamad added a commit that referenced this issue Jul 19, 2023
@ludamad
chore: docs in the monorepo
1d0de07 
Implements #1085. Aims to make docs more accessible during engineer feature development.
@ludamad ludamad mentioned this issue Jul 19, 2023
Merged
ludamad added a commit that referenced this issue Jul 19, 2023
@ludamad
chore: docs in the monorepo
d582d80 
Implements #1085. Aims to make docs more accessible during engineer feature development.
@github-project-automation github-project-automation bot moved this from Todo to Done in A3 Jul 20, 2023
@ludamad ludamad mentioned this issue Jul 20, 2023
Merged
6 tasks
ludamad added a commit that referenced this issue Jul 20, 2023
@ludamad
chore: docs in the monorepo
fe5a561 
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.
@ludamad ludamad reopened this Jul 20, 2023
@ludamad ludamad mentioned this issue Jul 20, 2023
Merged
6 tasks
ludamad added a commit that referenced this issue Jul 21, 2023
@ludamad
chore: add .gitrepo file to docs (#1130)
5b522ee 
After this, ./scripts/git_subrepo.sh docs pull <branch> can pull from any docs branch onto the current branch, albeit with history squashed. ./scripts/git_subrepo.sh docs push <branch> will push with history to the docs repo.

Part of #1085.
@ludamad ludamad mentioned this issue Jul 21, 2023
Closed
@iAmMichaelConnor
Copy link
Contributor

Closing, as this has been moved to 'Done'.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
A3
Archived in project
Milestone
No milestone
2 participants
@ludamad @iAmMichaelConnor