Skip to content

Commit 0ba3639

Browse files
committed
Streamline navigation by removing Playground and simplify implementations page
1 parent 079f714 commit 0ba3639

File tree

2 files changed

+1
-95
lines changed

2 files changed

+1
-95
lines changed

www/_config.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,6 @@ navigation:
9191
url: /spec/
9292
- title: Implementations
9393
url: /implementations/
94-
- title: Playground
95-
url: /playground/
9694
- title: Code Examples
9795
url: /code-examples/
9896
- title: Resources

www/pages/implementations.md

Lines changed: 1 addition & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -105,80 +105,6 @@ Below is a comprehensive list of all available IPCrypt implementations. Click on
105105
</div>
106106
</div>
107107

108-
## Implementation Documentation
109-
110-
Each implementation has (or will have) a dedicated documentation page with:
111-
112-
- **Installation Instructions**: How to add the implementation to your project
113-
- **Basic Usage Examples**: Code samples for all three encryption modes
114-
- **API Documentation**: Detailed method descriptions and parameter explanations
115-
- **Implementation Details**: Information about the underlying cryptographic operations
116-
- **Performance Considerations**: Guidance on optimizing for different use cases
117-
- **Test Vectors**: Information on verifying the implementation
118-
119-
Currently, detailed documentation is available for:
120-
- [Python Implementation]({{ site.baseurl }}/implementations/python/)
121-
122-
We're working on creating similar documentation for all other implementations. If you'd like to contribute documentation for an implementation, please see the [contribution guidelines]({{ site.baseurl }}/community/).
123-
124-
## Implementation Features
125-
126-
All implementations provide the following features:
127-
128-
- **Multiple Encryption Modes**: Support for `ipcrypt-deterministic`, `ipcrypt-nd`, and `ipcrypt-ndx`
129-
- **IPv4 and IPv6 Support**: Uniform handling of both address types
130-
- **Format Preservation**: Deterministic mode preserves IP address format
131-
- **Correlation Protection**: Non-deterministic modes prevent correlation attacks
132-
- **Test Vector Compliance**: Verified against the specification's test vectors
133-
134-
## Choosing an Implementation
135-
136-
Thanks to IPCrypt's consistent approach, all implementations provide identical cryptographic guarantees and functionality. This means you can choose an implementation based primarily on practical considerations rather than security differences:
137-
138-
1. **Language Compatibility**: Choose an implementation that integrates well with your existing codebase
139-
2. **Performance Requirements**: Some implementations (like C and Rust) may offer better performance
140-
3. **Platform Constraints**: Consider browser compatibility, memory usage, and deployment environment
141-
4. **Feature Needs**: All implementations support the core features, but some may offer additional utilities
142-
5. **Maintenance Preferences**: Consider your team's familiarity with the language and ecosystem
143-
144-
The beauty of IPCrypt's design is that you can switch between implementations as your needs evolve, without changing the underlying security properties or encryption results.
145-
146-
## Implementation Details
147-
148-
Each implementation page provides:
149-
150-
- Installation instructions
151-
- Basic usage examples
152-
- API documentation
153-
- Advanced usage patterns
154-
- Performance considerations
155-
- Links to source code repositories
156-
157-
## Creating a New Implementation
158-
159-
If you'd like to create an implementation in a language not currently supported, please follow these guidelines:
160-
161-
1. Implement all three encryption modes as specified in the document
162-
2. Verify your implementation against the test vectors
163-
3. Document your API and provide usage examples
164-
4. Submit your implementation to the [GitHub repository]({{ site.github_repo }})
165-
166-
### Documentation Template
167-
168-
To ensure consistency across implementation documentation, we recommend creating a documentation page with the following structure:
169-
170-
1. **Overview**: Brief description of the implementation
171-
2. **Installation**: How to install or include the implementation
172-
3. **Requirements**: Dependencies and system requirements
173-
4. **Usage Examples**: Code samples for all three encryption modes
174-
5. **API Reference**: Detailed method descriptions
175-
6. **Implementation Details**: Technical information about the implementation
176-
7. **Performance Considerations**: Guidance on optimizing for different use cases
177-
8. **Test Vectors**: Information on verifying the implementation
178-
9. **License**: Licensing information
179-
180-
You can use the [Python implementation documentation]({{ site.baseurl }}/implementations/python/) as a reference. For detailed guidance on creating a new implementation, see the [contribution guidelines]({{ site.baseurl }}/community/).
181-
182108
## Implementation Comparison
183109

184110
<div class="overflow-x-auto">
@@ -278,22 +204,4 @@ You can use the [Python implementation documentation]({{ site.baseurl }}/impleme
278204
</tr>
279205
</tbody>
280206
</table>
281-
</div>
282-
283-
## Contributing to Implementations
284-
285-
We welcome contributions to existing implementations and the creation of new ones. Here are some ways you can contribute:
286-
287-
1. **Bug Fixes**: Help improve existing implementations by fixing bugs or addressing issues
288-
2. **Performance Improvements**: Optimize implementations for better performance
289-
3. **Documentation**: Create or improve documentation for implementations
290-
4. **New Features**: Add new features or enhancements to existing implementations
291-
5. **New Implementations**: Create implementations for languages not currently supported
292-
293-
If you're interested in contributing, please:
294-
295-
1. Check the [GitHub repository]({{ site.github_repo }}) for open issues
296-
2. Review the [contribution guidelines]({{ site.baseurl }}/community/)
297-
3. Join the [community discussion]({{ site.baseurl }}/community/) to coordinate with other contributors
298-
299-
Your contributions help make IPCrypt more accessible and useful for everyone!
207+
</div>

0 commit comments

Comments
 (0)