-
Notifications
You must be signed in to change notification settings - Fork 218
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
Initial refactor of OP Mainnet -> OP Stack #1243
Draft
bradleycamacho
wants to merge
2
commits into
main
Choose a base branch
from
mainnet-refactor
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+145
−69
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
// Primary Context | ||
|
||
When assisting with this project: | ||
|
||
Recognize this is a technical writing project for Optimism documentation | ||
Default to Microsoft Style Guide conventions, specifically: | ||
- Use sentence-style capitalization for headings | ||
- Use active voice and plain language | ||
- Structure lists clearly and concisely | ||
- Avoid unnecessary jargon or complex phrasing | ||
Align with Optimism’s style guide, focusing on: | ||
- Consistent use of terminology | ||
- Clear and direct explanations of technical concepts | ||
- Accurate and up-to-date references to tools and resources | ||
Maintain a professional yet approachable tone, prioritizing clarity and consistency | ||
|
||
// Writing Style Rules | ||
|
||
Ensure headings use sentence-style capitalization (e.g., "Writing style rules" instead of "Writing Style Rules") | ||
Use active voice and concise technical language (e.g., "Deploy the contract" instead of "The contract was deployed") | ||
Maintain consistent terminology across sections, referring to the Optimism glossary (e.g., always refer to "Layer 2 scaling" instead of "L2" unless defined) | ||
Follow Microsoft guidelines for bulleted and numbered lists, ensuring parallel structure (e.g., each bullet in a list should start with a verb if others do) | ||
Avoid idiomatic expressions or informal language | ||
Ensure all tables, figures, and examples are correctly labeled and referenced | ||
Validate cross-references to ensure accuracy (e.g., check that section numbers and hyperlinks point to the correct locations) | ||
Ensure any changes to a term, reference, or hyperlink are reflected throughout the document | ||
|
||
// Code Snippet Rules | ||
|
||
Ensure code snippets are syntactically correct and properly formatted | ||
Use consistent indentation and naming conventions within snippets | ||
Provide comments explaining non-obvious code logic | ||
Validate that all code examples are functional and tested | ||
Ensure code snippets are referenced correctly in accompanying text | ||
|
||
// Hyperlink and Reference Rules | ||
|
||
Ensure all hyperlinks use descriptive text (e.g., “Learn more about Optimism” instead of “Click here”) | ||
Verify all hyperlinks are valid and up to date | ||
Follow Microsoft guidelines for citing external references, ensuring clarity and relevance | ||
|
||
// Accessibility and Inclusivity Rules | ||
|
||
Use gender-neutral language | ||
Avoid cultural references that may not be universally understood | ||
Ensure content is easily translatable by avoiding idioms and complex sentence structures | ||
Provide alt text for all images and diagrams, describing their purpose and content | ||
|
||
// Document Structure Rules | ||
|
||
Maintain a clear and logical document hierarchy with appropriate use of headings | ||
Use introductory paragraphs to outline the purpose of each section | ||
Ensure transition sentences between sections for smooth reading flow | ||
|
||
// Response Format | ||
|
||
Provide direct, implementable suggestions for improvements | ||
Highlight areas where consistency or accuracy issues may arise | ||
Separate code, text, and LaTeX suggestions for clarity | ||
Flag outdated or broken links and provide corrected URLs or suggestions for updates | ||
Note any assumptions made in the response | ||
|
||
// Quality Assurance | ||
|
||
Validate adherence to the key Microsoft Style Guide principles listed | ||
Check consistency of terminology, formatting, and references as per the Optimism style guide | ||
Ensure all tables, figures, and code snippets are properly labeled and integrated | ||
Verify cross-reference accuracy within the document | ||
|
||
// Meta Instructions | ||
|
||
Anticipate and suggest potential improvements for related sections | ||
Maintain consistent tone and terminology throughout | ||
Flag potential inconsistencies or deviations from the style guide | ||
Proactively highlight areas for refinement or optimization | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do we do with this file? Is there a way to expand it to include all contract addresses across the Superchain?